mirror of
https://github.com/wahyd4/gitlabhq.git
synced 2026-08-09 04:36:11 +10:00
Split external issue tracker document
[ci skip]
This commit is contained in:
Achilleas Pipinellis
@@ -1,44 +1,30 @@
|
||||
# External issue tracker
|
||||
|
||||
GitLab has a great issue tracker but you can also use an external issue tracker such as Jira, Bugzilla or Redmine. You can configure issue trackers per GitLab project. For instance, if you configure Jira it allows you to do the following:
|
||||
GitLab has a great issue tracker but you can also use an external one such as
|
||||
Jira or Redmine. Issue trackers are configurable per GitLab project and allow
|
||||
you to do the following:
|
||||
|
||||
- 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;
|
||||
- To reference Jira issue PROJECT-1234 in comments, use syntax PROJECT-1234. Commit messages get turned into HTML links to the corresponding Jira issue.
|
||||
|
||||
|
||||
|
||||
GitLab Enterprise Edition contains [advanced JIRA support](http://doc.gitlab.com/ee/integration/jira.html).
|
||||
- the **Issues** link on the GitLab project pages takes you to the appropriate
|
||||
issue index of the external tracker
|
||||
- clicking **New issue** on the project dashboard creates a new issue on the
|
||||
external tracker
|
||||
|
||||
## Configuration
|
||||
|
||||
The configuration is done via a project's **Services**.
|
||||
|
||||
### Project Service
|
||||
|
||||
You can enable an external issue tracker per project. As an example, we will configure `Redmine` for project named gitlab-ci.
|
||||
To enable an external issue tracker you must configure the appropriate **Service**.
|
||||
Visit the links below for details:
|
||||
|
||||
Fill in the required details on the page:
|
||||
|
||||
|
||||
|
||||
* `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 is used by GitLab 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.
|
||||
- [Redmine](../project_services/redmine.md)
|
||||
- [Jira](jira.md)
|
||||
|
||||
### Service Template
|
||||
|
||||
It is necessary to configure the external issue tracker per project, because project specific details are needed for the integration with GitLab.
|
||||
The admin can add a service template that sets a default for each project. This makes it much easier to configure individual projects.
|
||||
To save you the hassle from configuring each project's service individually,
|
||||
GitLab provides the ability to set Service Templates which can then be
|
||||
overridden in each project's settings.
|
||||
|
||||
In GitLab Admin section, navigate to `Service Templates` and choose the service template you want to create:
|
||||
|
||||
|
||||
|
||||
After the template is created, the template details will be pre-filled on the project service page.
|
||||
|
||||
NOTE: For each project, you will still need to configure the issue tracking URLs by replacing `:issues_tracker_id` in the above screenshot
|
||||
with the ID used by your external issue tracker. Prior to GitLab v7.8, this ID was configured in the project settings, and GitLab would automatically
|
||||
update the URL configured in `gitlab.yml`. This behavior is now depecated, and all issue tracker URLs must be configured directly
|
||||
within the project's Services settings.
|
||||
|
||||
Support to add your commits to the Jira ticket automatically is [available in GitLab EE](http://doc.gitlab.com/ee/integration/jira.html).
|
||||
Read more on [Services Templates](../project_services/services_templates.md).
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 116 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 193 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
@@ -26,5 +26,12 @@ further configuration instructions and details. Contributions are welcome.
|
||||
| JetBrains TeamCity CI | A continuous integration and build server |
|
||||
| PivotalTracker | Project Management Software (Source Commits Endpoint) |
|
||||
| Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop |
|
||||
| Redmine | Redmine issue tracker |
|
||||
| [Redmine](redmine.md) | Redmine issue tracker |
|
||||
| Slack | A team communication tool for the 21st century |
|
||||
|
||||
## Services Templates
|
||||
|
||||
Services templates is a way to set some predefined values in the Service of
|
||||
your liking which will then be pre-filled on each project's Service.
|
||||
|
||||
Read more about [Services Templates in this document](services_templates.md).
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# Redmine Service
|
||||
|
||||
Go to your project's **Settings > Services > Redmine** and fill in the required
|
||||
details as described in the table below.
|
||||
|
||||
| Field | Description |
|
||||
| ----- | ----------- |
|
||||
| `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 is used by GitLab 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 |
|
||||
|
||||
Once you have configured and enabled Redmine:
|
||||
|
||||
- the **Issues** link on the GitLab project pages takes you to the appropriate
|
||||
Redmine issue index
|
||||
- clicking **New issue** on the project dashboard creates a new Redmine issue
|
||||
|
||||
As an example, below is a configuration for a project named gitlab-ci.
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# Services Templates
|
||||
|
||||
A GitLab administrator can add a service template that sets a default for each
|
||||
project. This makes it much easier to configure individual projects.
|
||||
|
||||
After the template is created, the template details will be pre-filled on a
|
||||
project's Service page.
|
||||
|
||||
## Enable a Service template
|
||||
|
||||
In GitLab's Admin area, navigate to **Service Templates** and choose the
|
||||
service template you wish to create.
|
||||
|
||||
For example, in the image below you can see Redmine.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
**NOTE:** For each project, you will still need to configure the issue tracking
|
||||
URLs by replacing `:issues_tracker_id` in the above screenshot with the ID used
|
||||
by your external issue tracker. Prior to GitLab v7.8, this ID was configured in
|
||||
the project settings, and GitLab would automatically update the URL configured
|
||||
in `gitlab.yml`. This behavior is now deprecated and all issue tracker URLs
|
||||
must be configured directly within the project's **Services** settings.
|
||||
Reference in New Issue
Block a user