Commit eccf6956 authored by Marin Jankovski's avatar Marin Jankovski

Explained in the integration documentation how to enable external issue tracker

parent d899bc91
...@@ -14,9 +14,23 @@ ...@@ -14,9 +14,23 @@
# #
class JiraService < IssueTrackerService class JiraService < IssueTrackerService
include Rails.application.routes.url_helpers
prop_accessor :title, :description, :project_url, :issues_url, :new_issue_url prop_accessor :title, :description, :project_url, :issues_url, :new_issue_url
def help
issue_tracker_link = help_page_path("integration", "external-issue-tracker")
line1 = "Setting `project_url`, `issues_url` and `new_issue_url` will "\
"allow a user to easily navigate to the Jira issue tracker. "\
"See the [integration doc](#{issue_tracker_link}) for details."
line2 = 'Support for referencing commits and automatic closing of Jira issues directly ' \
'from GitLab is [available in GitLab EE.](http://doc.gitlab.com/ee/integration/jira.html)'
[line1, line2].join("\n\n")
end
def title def title
if self.properties && self.properties['title'].present? if self.properties && self.properties['title'].present?
self.properties['title'] self.properties['title']
......
...@@ -9,6 +9,10 @@ ...@@ -9,6 +9,10 @@
.alert.alert-danger .alert.alert-danger
- @service.errors.full_messages.each do |msg| - @service.errors.full_messages.each do |msg|
%p= msg %p= msg
- if @service.help.present?
.bs-callout
= preserve do
= markdown @service.help
- @service.fields.each do |field| - @service.fields.each do |field|
- name = field[:name] - name = field[:name]
......
...@@ -46,7 +46,7 @@ ...@@ -46,7 +46,7 @@
%span %span
Applications Applications
= nav_link(controller: :application_settings) do = nav_link(controller: :services) do
= link_to admin_application_settings_services_path, title: 'Service Templates' do = link_to admin_application_settings_services_path, title: 'Service Templates' do
%i.fa.fa-copy %i.fa.fa-copy
%span %span
......
# External issue tracker # External issue tracker
GitLab has a great issue tracker but you can also use an external issue tracker such as JIRA, Bugzilla or Redmine. This is something that you can turn on per GitLab project. If for example you configure JIRA it provides the following functionality: GitLab has a great issue tracker but you can also use an external issue tracker such as Jira, Bugzilla or Redmine. This is something that you can turn on per GitLab project. If for example you configure Jira it provides the following functionality:
- the 'Issues' link on the GitLab project pages takes you to the appropriate JIRA issue index; - the 'Issues' link on the GitLab project pages takes you to the appropriate Jira issue index;
- clicking 'New issue' on the project dashboard creates a new JIRA issue; - clicking 'New issue' on the project dashboard creates a new Jira issue;
- To reference JIRA issue PROJECT-1234 in comments, use syntax PROJECT-1234. Commit messages get turned into HTML links to the corresponding JIRA issue. - To reference Jira issue PROJECT-1234 in comments, use syntax PROJECT-1234. Commit messages get turned into HTML links to the corresponding Jira issue.
![Jira screenshot](jira-integration-points.png) ![Jira screenshot](jira-integration-points.png)
You can configure the integration in the gitlab.yml configuration file. ## Configuration
### Project Service
External issue tracker can be enabled per project basis. As an example, we will configure `Redmine` for project named gitlab-ci.
Fill in the required details on the page:
![redmine configuration](redmine_configuration.png)
* `description` A name for the issue tracker (to differentiate between instances, for example).
* `project_url` The URL to the project in Redmine which is being linked to this GitLab project.
* `issues_url` The URL to the issue in Redmine project that is linked to this GitLab project. Note that the `issues_url` requires `:id` in the url. This id GitLab uses as a placeholder to replace the issue number.
* `new_issue_url` This is the URL to create a new issue in Redmine for the project linked to this GitLab project.
### Service Template
Since external issue tracker needs some project specific details, it is required to enable issue tracker per project level.
GitLab makes this easier by allowing admin to add a service template which will allow GitLab project user with permissions to edit details for its project.
In GitLab Admin section, navigate to `Service Templates` and choose the service template you want to create:
![redmine service template](redmine_service_template.png)
After the template is created, the template details will be pre-filled on the project service page.
Support to add your commits to the Jira ticket automatically is [available in GitLab EE](http://doc.gitlab.com/ee/integration/jira.html). Support to add your commits to the Jira ticket automatically is [available in GitLab EE](http://doc.gitlab.com/ee/integration/jira.html).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment