Commit 9f372fc1 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis Committed by Alejandro Rodríguez

Merge branch 'revert-a0d5bb0b' into 'master'

Revert "Merge branch 'docs/jira-old' into 'master'"

See merge request !7531
parent f028fa6f
...@@ -57,9 +57,9 @@ class JiraService < IssueTrackerService ...@@ -57,9 +57,9 @@ class JiraService < IssueTrackerService
end end
def help def help
'See the ' \ 'You need to configure JIRA before enabling this service. For more details
'[integration doc](http://doc.gitlab.com/ce/integration/external-issue-tracker.html) '\ read the
'for details.' [JIRA service documentation](https://docs.gitlab.com/ce/project_services/jira.html).'
end end
def title def title
......
...@@ -5,7 +5,7 @@ trackers and external authentication. ...@@ -5,7 +5,7 @@ trackers and external authentication.
See the documentation below for details on how to configure these services. See the documentation below for details on how to configure these services.
- [Jira](../project_services/jira.md) Integrate with the JIRA issue tracker - [JIRA](../project_services/jira.md) Integrate with the JIRA issue tracker
- [External issue tracker](external-issue-tracker.md) Redmine, JIRA, etc. - [External issue tracker](external-issue-tracker.md) Redmine, JIRA, etc.
- [LDAP](ldap.md) Set up sign in via LDAP - [LDAP](ldap.md) Set up sign in via LDAP
- [OmniAuth](omniauth.md) Sign in via Twitter, GitHub, GitLab.com, Google, Bitbucket, Facebook, Shibboleth, SAML, Crowd and Azure - [OmniAuth](omniauth.md) Sign in via Twitter, GitHub, GitLab.com, Google, Bitbucket, Facebook, Shibboleth, SAML, Crowd and Azure
......
# GitLab JIRA integration
This document was moved under [project_services/jira](../project_services/jira.md).
# GitLab JIRA integration # GitLab JIRA integration
>**Note:** GitLab can be configured to interact with JIRA. Configuration happens via
Full JIRA integration was previously exclusive to GitLab Enterprise Edition. user name and password. Connecting to a JIRA server via CAS is not possible.
With [GitLab 8.3 forward][8_3_post], this feature in now [backported][jira-ce]
to GitLab Community Edition as well.
--- Each project can be configured to connect to a different JIRA instance, see the
[configuration](#configuration) section. If you have one JIRA instance you can
GitLab can be configured to interact with [JIRA Core] either using an pre-fill the settings page with a default template. To configure the template
on-premises instance or the SaaS solution that Atlassian offers. Configuration see the [Services Templates][services-templates] document.
happens via username and password on a per-project basis. Connecting to a JIRA
server via CAS is not possible.
Each project can be configured to connect to a different JIRA instance or, in Once the project is connected to JIRA, you can reference and close the issues
case you have a single JIRA instance, you can pre-fill the JIRA service in JIRA directly from GitLab.
settings page in GitLab with a default template. To configure the JIRA template,
see the [Services Templates documentation][services-templates].
Once the GitLab project is connected to JIRA, you can reference and close the
issues in JIRA directly from GitLab's merge requests.
## Configuration ## Configuration
The configuration consists of two parts: 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.
- [JIRA configuration](#configuring-jira)
- [GitLab configuration](#configuring-gitlab)
### Configuring JIRA ### Configuring JIRA
First things first, we need to create a user in JIRA which will have access to We need to create a user in JIRA which will have access to all projects that
all projects that need to integrate with GitLab. need to integrate with GitLab. Login to your JIRA instance as admin and under
Administration go to User Management and create a new user.
As an example, we'll create a user named `gitlab` and add it to `JIRA-developers`
group.
**It is important that the user `GitLab` has write-access to projects in JIRA**
We have split this stage in steps so it is easier to follow. We have split this stage in steps so it is easier to follow.
...@@ -62,12 +57,12 @@ We have split this stage in steps so it is easier to follow. ...@@ -62,12 +57,12 @@ We have split this stage in steps so it is easier to follow.
Give it an optional description and hit **Create group**. Give it an optional description and hit **Create group**.
![JIRA create new group](img/jira_create_new_group_name.png) ![jira create new group](img/jira_create_new_group_name.png)
--- ---
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.
![JIRA group access](img/jira_group_access.png) ![JIRA group access](img/jira_group_access.png)
...@@ -75,7 +70,7 @@ We have split this stage in steps so it is easier to follow. ...@@ -75,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.
...@@ -88,50 +83,30 @@ password as they will be needed when configuring GitLab in the next section. ...@@ -88,50 +83,30 @@ password as they will be needed when configuring GitLab in the next section.
### Configuring GitLab ### Configuring GitLab
>**Note:** >**Notes:**
The currently supported JIRA versions are v6.x and v7.x. and GitLab - The currently supported JIRA versions are `v6.x` and `v7.x.`. GitLab 7.8 or
7.8 or higher is required. 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].
Assuming you [have already configured JIRA](#configuring-jira), now it's time
to configure GitLab. To enable JIRA integration in a project, navigate to your project's
**Services ➔ JIRA** and fill in the required details on the page as described
JIRA configuration in GitLab is done via a project's in the table below.
[**Services**](../project_services/project_services.md).
| Field | Description |
To enable JIRA integration in a project, navigate to the project's | ----- | ----------- |
**Settings > Services > JIRA**. | `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, the identifier for your JIRA project, all uppercase. |
Fill in the required details on the page, as described in the table below. | `Username` | The user name created in [configuring JIRA step](#configuring-jira). |
| Setting | Description |
| ------- | ----------- |
| `Description` | A name for the issue tracker (to differentiate between instances, for example). |
| `Project url` | The URL to the JIRA project which is being linked to this GitLab project. It is of the form: `https://<jira_host_url>/issues/?jql=project=<jira_project>`. |
| `Issues url` | The URL to the JIRA project issues overview for the project that is linked to this GitLab project. It is of the form: `https://<jira_host_url>/browse/:id`. Leave `:id` as-is, it gets replaced by GitLab at runtime. |
| `New issue url` | This is the URL to create a new issue in JIRA for the project linked to this GitLab project, and it is of the form: `https://<jira_host_url>/secure/CreateIssue.jspa` |
| `Api url` | The base URL of the JIRA API. It may be omitted, in which case GitLab will automatically use API version `2` based on the `project url`. It is of the form: `https://<jira_host_url>/rest/api/2`. |
| `Username` | The username of the user 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 setting is very important to set up correctly. It is the ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (**Administration > Issues > Workflows**) by selecting **View** under **Operations** of the desired workflow of your project. The ID of each state can be found inside the parenthesis of each transition name under the **Transitions (id)** column ([see screenshot][trans]). By default, this ID is set to `2`. | | `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
with the linked JIRA project. with the linked JIRA project.
For example, given the settings below:
- the JIRA URL is `https://jira.example.com`
- the project is named `GITLAB`
- the user is named `gitlab`
- the JIRA issue transition is 151 (based on the [JIRA issue transition][trans])
the following screenshot shows how the JIRA service settings should look like.
![JIRA service page](img/jira_service_page.png) ![JIRA service page](img/jira_service_page.png)
[trans]: img/jira_issues_workflow.png
--- ---
## JIRA issues ## JIRA issues
...@@ -143,36 +118,28 @@ ID in GitLab commits and merge requests. ...@@ -143,36 +118,28 @@ ID in GitLab commits and merge requests.
### Referencing JIRA Issues ### Referencing JIRA Issues
If you reference a JIRA issue, e.g., `GITLAB-1`, in a commit comment, a link When GitLab project has JIRA issue tracker configured and enabled, mentioning
which points back to JIRA is created. 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:
The same works for comments in merge requests as well. ```
USER mentioned this issue in RESOURCE_NAME of [PROJECT_NAME|LINK_TO_COMMENT]:
ENTITY_TITLE
```
![JIRA add GitLab commit message](img/jira_add_gitlab_commit_message.png) * `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.
The mentioning action is two-fold, so a comment with a JIRA issue in GitLab ![example of mentioning or closing the JIRA issue](img/jira_issue_reference.png)
will automatically add a comment in that particular JIRA issue with the link
back to GitLab.
![JIRA reference commit message](img/jira_reference_commit_message_in_jira_issue.png)
--- ---
The comment on the JIRA issue is of the form: ### Closing JIRA Issues
> USER mentioned this issue in LINK_TO_THE_MENTION
Where:
| Format | Description |
| ------ | ----------- |
| `USER` | A user that mentioned the issue. This is the link to the user profile in GitLab. |
| `LINK_TO_THE_MENTION` | Link to the origin of mention with a name of the entity where JIRA issue was mentioned. Can be commit or merge request. |
### Closing JIRA issues
JIRA issues can be closed directly from GitLab by using trigger words in 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 commits and merge requests. When a commit which contains the trigger word
...@@ -187,60 +154,54 @@ the same goal: ...@@ -187,60 +154,54 @@ the same goal:
- `Closes GITLAB-1` - `Closes GITLAB-1`
- `Fixes GITLAB-1` - `Fixes GITLAB-1`
where `GITLAB-1` the issue ID of the JIRA project. - where `GITLAB-1` the issue ID of the JIRA project.
### JIRA issue closing example ### JIRA issue closing example
Let's say for example that we submitted a bug fix and created a merge request Let's consider the following example:
in GitLab. The workflow would be something like this:
1. Create a new branch 1. For the project named `PROJECT` in JIRA, we implemented a new feature
1. Fix the bug and created a merge request in GitLab.
1. Commit the changes and push branch to GitLab 1. This feature was requested in JIRA issue `PROJECT-7` and the merge request
1. Open a new merge request and reference the JIRA issue including one of the in GitLab contains the improvement
trigger words, e.g.: `Fixes GITLAB-1`, in the description 1. In the merge request description we use the issue closing trigger
1. Submit the merge request `Closes PROJECT-7`.
1. Ask someone to review 1. Once the merge request is merged, the JIRA issue will be automatically closed
1. Merge the merge request with a comment and an associated link to the commit that resolved the issue.
1. The JIRA issue is automatically closed
--- ---
In the following screenshot you can see what the link references to the JIRA In the following screenshot you can see what the link references to the JIRA
issue look like. issue look like.
![JIRA - submit a GitLab merge request](img/jira_submit_gitlab_merge_request.png) ![A Git commit that causes the JIRA issue to be closed](img/jira_merge_request_close.png)
--- ---
Once this merge request is merged, the JIRA issue will be automatically closed Once this merge request is merged, the JIRA issue will be automatically closed
with a link to the commit that resolved the issue. with a link to the commit that resolved the issue.
![The GitLab integration user leaves a comment on JIRA](img/jira_issue_closed.png) ![The GitLab integration closes JIRA issue](img/jira_service_close_issue.png)
--- ---
You can see from the above image that there are four references to GitLab: ![The GitLab integration creates a comment and a link on JIRA issue.](img/jira_service_close_comment.png)
- The first is from a comment in a specific commit
- The second is from the JIRA issue reference in the merge request description
- The third is from the actual commit that solved the issue
- And the fourth is from the commit that the merge request created
[services-templates]: ../project_services/services_templates.md "Services templates documentation"
[JIRA Core]: https://www.atlassian.com/software/jira/core "The JIRA Core website"
[jira-ce]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2146 "MR - Backport JIRA service"
[8_3_post]: https://about.gitlab.com/2015/12/22/gitlab-8-3-released/ "GitLab 8.3 release post"
## Troubleshooting ## Troubleshooting
If things don't work as expected that's usually because you have configured
incorrectly the JIRA-GitLab integration.
### GitLab is unable to comment on a ticket ### GitLab is unable to comment on a ticket
Make sure that the user you set up for GitLab to communicate with JIRA has the Make sure that the user you set up for GitLab to communicate with JIRA has the
correct access permission to post comments on a ticket and to also transition the correct access permission to post comments on a ticket and to also transition
ticket, if you'd like GitLab to also take care of closing them. the ticket, if you'd like GitLab to also take care of closing them.
### GitLab is unable to close a ticket ### GitLab is unable to close a ticket
Make sure the the `Transition ID` you set within the JIRA settings matches the Make sure the `Transition ID` you set within the JIRA settings matches the one
one your project needs to close a ticket. your project needs to close a ticket.
[services-templates]: ../project_services/services_templates.md
[jira-repo-docs]: https://gitlab.com/gitlab-org/gitlab-ce/blob/8-13-stable/doc/project_services/jira.md
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