## Configuration
## Configuration
In order to enable the JIRA service in GitLab, you need to first configure the
project in JIRA and then enter the correct values in GitLab.
### Configuring JIRA
### Configuring JIRA
We need to create a user in JIRA which will have access to all projects that
We need to create a user in JIRA which will have access to all projects that
...
@@ -115,7 +62,7 @@ We have split this stage in steps so it is easier to follow.
...
@@ -115,7 +62,7 @@ We have split this stage in steps so it is easier to follow.
---
---
1. Give the newly-created group write access by going to
1. Give the newly-created group write access by going to
**Application access > View configuration** and adding the `gitlab-developers`
**Application access ➔ View configuration** and adding the `gitlab-developers`
group to JIRA Core.
group to JIRA Core.
...
@@ -123,7 +70,7 @@ We have split this stage in steps so it is easier to follow.
...
@@ -123,7 +70,7 @@ We have split this stage in steps so it is easier to follow.
---
---
1. Add the `gitlab` user to the `gitlab-developers` group by going to
1. Add the `gitlab` user to the `gitlab-developers` group by going to
**Users > GitLab user > Add group** and selecting the `gitlab-developers`
**Users ➔ GitLab user ➔ Add group** and selecting the `gitlab-developers`
group from the dropdown menu. Notice that the group says _Access_ which is
group from the dropdown menu. Notice that the group says _Access_ which is
what we aim for.
what we aim for.
...
@@ -136,22 +83,23 @@ password as they will be needed when configuring GitLab in the next section.
...
@@ -136,22 +83,23 @@ password as they will be needed when configuring GitLab in the next section.
### Configuring GitLab
### Configuring GitLab
JIRA configuration in GitLab is done via a project's **Services**.
>**Notes:**
- The currently supported JIRA versions are `v6.x` and `v7.x.`. GitLab 7.8 or
#### GitLab 8.13.0 with JIRA v1000.x
higher is required.
- GitLab 8.14 introduced a new way to integrate with JIRA which greatly simplified
the configuration options you have to enter. If you are using an older version,
[follow this documentation][jira-repo-docs].
To enable JIRA integration in a project, navigate to the project's
To enable JIRA integration in a project, navigate to your project's
and open the context menu clicking on the top right gear icon, then go to
**Services ➔ JIRA** and fill in the required details on the page as described
**Services>JIRA**.
in the table below.
Fill in the required details on the page as described in the table below.
| Field | Description |
| Field | Description |
| ----- | ----------- |
| ----- | ----------- |
| `URL` | The base URL to the JIRA project which is being linked to this GitLab project. Ex. https://JIRA.example.com |
| `URL` | The base URL to the JIRA project which is being linked to this GitLab project. E.g., `https://jira.example.com`. |
| `Project key` | The short, all capital letter identifier for your JIRA project. |
| `Project key` | The short, the identifier for your JIRA project, all uppercase. |
| `Username` | The user name created in [configuring JIRA step](#configuring-JIRA). |
| `Username` | The user name created in [configuring JIRA step](#configuring-jira). |
| `Password` |The password of the user created in [configuring JIRA step](#configuring-JIRA). |
| `Password` |The password of the user created in [configuring JIRA step](#configuring-jira). |
| `JIRA issue transition` | This is the ID of a transition that moves issues to a closed state. You can find this number under JIRA workflow administration ([see screenshot](img/jira_workflow_screenshot.png)). |
| `JIRA issue transition` | This is the ID of a transition that moves issues to a closed state. You can find this number under JIRA workflow administration ([see screenshot](img/jira_workflow_screenshot.png)). |
After saving the configuration, your GitLab project will be able to interact
After saving the configuration, your GitLab project will be able to interact
...
@@ -161,40 +109,99 @@ with the linked JIRA project.
...
@@ -161,40 +109,99 @@ with the linked JIRA project.
---
---
#### GitLab 6.x-7.7 with JIRA v6.x
## JIRA issues
By now you should have [configured JIRA](#configuring-jira) and enabled the
[JIRA service in GitLab](#configuring-gitlab). If everything is set up correctly
you should be able to reference and close JIRA issues by just mentioning their
ID in GitLab commits and merge requests.
### Referencing JIRA Issues
When GitLab project has JIRA issue tracker configured and enabled, mentioning
JIRA issue in GitLab will automatically add a comment in JIRA issue with the
link back to GitLab. This means that in comments in merge requests and commits
referencing an issue, eg. `PROJECT-7`, will add a comment in JIRA issue in the
format:
```
USER mentioned this issue in RESOURCE_NAME of [PROJECT_NAME|LINK_TO_COMMENT]:
ENTITY_TITLE
```
*`USER` A user that mentioned the issue. This is the link to the user profile in GitLab.
*`LINK_TO_THE_COMMENT` Link to the origin of mention with a name of the entity where JIRA issue was mentioned.
*`RESOURCE_NAME` Kind of resource which referenced the issue. Can be a commit or merge request.
*`PROJECT_NAME` GitLab project name.
*`ENTITY_TITLE` Merge request title or commit message first line.
---
### Closing JIRA Issues
JIRA issues can be closed directly from GitLab by using trigger words in
commits and merge requests. When a commit which contains the trigger word
followed by the JIRA issue ID in the commit message is pushed, GitLab will
add a comment in the mentioned JIRA issue and immediately close it (provided
the transition ID was set up correctly).
There are currently three trigger words, and you can use either one to achieve
the same goal:
_**Note:** GitLab versions 8.13.0 and up contain various integration improvements.
-`Resolves GITLAB-1`
We strongly recommend upgrading._
-`Closes GITLAB-1`
-`Fixes GITLAB-1`
In `gitlab.yml` enable the JIRA issue tracker section by
- where `GITLAB-1` the issue ID of the JIRA project.
[uncommenting these lines][JIRA-gitlab-yml]. This will make sure that all
issues within GitLab are pointing to the JIRA issue tracker.
After you set this, you will be able to close issues in JIRA by a commit in
### JIRA issue closing example
GitLab.
Go to your project's **Settings** page and fill in the project name for the
Let's consider the following example:
JIRA project:
1. For the project named `PROJECT` in JIRA, we implemented a new feature
and created a merge request in GitLab.
1. This feature was requested in JIRA issue `PROJECT-7` and the merge request
in GitLab contains the improvement
1. In the merge request description we use the issue closing trigger
`Closes PROJECT-7`.
1. Once the merge request is merged, the JIRA issue will be automatically closed
with a comment and an associated link to the commit that resolved the issue.
---
In the following screenshot you can see what the link references to the JIRA
issue look like.
---
---
You can also enable the JIRA service that will allow you to interact with JIRA
Once this merge request is merged, the JIRA issue will be automatically closed
issues. Go to the **Settings > Services > JIRA** and:
with a link to the commit that resolved the issue.
