mirror of
https://github.com/wahyd4/gitlabhq.git
synced 2026-08-20 18:16:45 +10:00
Merge branch 'doc_refactor_jira' into 'master'
Refactor JIRA documentation Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/12680 ## TODO - [x] Move JIRA docs from `integration/` to `project_services/` - [x] Split old JIRA info - [x] Add note on document migration - [x] Change references to new location - [x] Add new images - [x] Clean-up `jira.md` See merge request !2592
This commit is contained in:
Achilleas Pipinellis
@@ -5,7 +5,7 @@ trackers and external authentication.
|
||||
|
||||
See the documentation below for details on how to configure these services.
|
||||
|
||||
- [Jira](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.
|
||||
- [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
|
||||
|
||||
@@ -19,7 +19,7 @@ To enable an external issue tracker you must configure the appropriate **Service
|
||||
Visit the links below for details:
|
||||
|
||||
- [Redmine](../project_services/redmine.md)
|
||||
- [Jira](jira.md)
|
||||
- [Jira](../project_services/jira.md)
|
||||
|
||||
### Service Template
|
||||
|
||||
|
||||
+2
-148
@@ -1,149 +1,3 @@
|
||||
# GitLab Jira integration
|
||||
# GitLab JIRA integration
|
||||
|
||||
GitLab can be configured to interact with Jira. Configuration happens via
|
||||
username and password. Connecting to a Jira server via CAS is not possible.
|
||||
|
||||
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
|
||||
pre-fill the settings page with a default template. To configure the template
|
||||
see the [Services Templates][services-templates] document.
|
||||
|
||||
Once the project is connected to Jira, you can reference and close the issues
|
||||
in Jira directly from GitLab.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Referencing Jira Issues from GitLab](#referencing-jira-issues)
|
||||
* [Closing Jira Issues from GitLab](#closing-jira-issues)
|
||||
* [Configuration](#configuration)
|
||||
|
||||
### 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 LINK_TO_THE_MENTION
|
||||
```
|
||||
|
||||
* `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, eg.
|
||||
`Resolves PROJECT-1`, `Closes PROJECT-1` or `Fixes PROJECT-1`, in commits and
|
||||
merge requests. When a commit which contains the trigger word in the commit
|
||||
message is pushed, GitLab will add a comment in the mentioned Jira issue.
|
||||
|
||||
For example, for project named `PROJECT` in Jira, we implemented a new feature
|
||||
and created a merge request in GitLab.
|
||||
|
||||
This feature was requested in Jira issue `PROJECT-7`. Merge request in GitLab
|
||||
contains the improvement and in merge request description we say that this
|
||||
merge request `Closes PROJECT-7` issue.
|
||||
|
||||
Once this merge request is merged, the Jira issue will be automatically closed
|
||||
with a link to the commit that resolved the issue.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
### Configuring JIRA
|
||||
|
||||
We need to create a user in JIRA which will have access to all projects that
|
||||
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**
|
||||
|
||||
### Configuring GitLab
|
||||
|
||||
JIRA configuration in GitLab is done via a project's **Services**.
|
||||
|
||||
#### GitLab 7.8 and up with JIRA v6.x
|
||||
|
||||
See next section.
|
||||
|
||||
#### GitLab 7.8 and up
|
||||
|
||||
_The currently supported JIRA versions are v6.x and v7.x._
|
||||
|
||||
To enable JIRA integration in a project, navigate to the project's
|
||||
**Settings > Services > JIRA**.
|
||||
|
||||
Fill in the required details on the page as described in the table below.
|
||||
|
||||
| Field | Description |
|
||||
| ----- | ----------- |
|
||||
| `description` | A name for the issue tracker (to differentiate between instances, for instance). |
|
||||
| `project url` | The URL to the JIRA project which is being linked to this GitLab project. |
|
||||
| `issues url` | The URL to the JIRA project issues overview for the project that is linked to this GitLab project. |
|
||||
| `new issue url` | This is the URL to create a new issue in JIRA for the project linked to this GitLab project. |
|
||||
| `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`, i.e. `https://jira.example.com/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). |
|
||||
| `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)). By default, this ID is `2` (in the example image, this is `2` as well) |
|
||||
|
||||
After saving the configuration, your GitLab project will be able to interact
|
||||
with the linked JIRA project.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### GitLab 6.x-7.7 with JIRA v6.x
|
||||
|
||||
_**Note:** GitLab versions 7.8 and up contain various integration improvements.
|
||||
We strongly recommend upgrading._
|
||||
|
||||
In `gitlab.yml` enable the JIRA issue tracker section by
|
||||
[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
|
||||
GitLab.
|
||||
|
||||
Go to your project's **Settings** page and fill in the project name for the
|
||||
JIRA project:
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
You can also enable the JIRA service that will allow you to interact with JIRA
|
||||
issues. Go to the **Settings > Services > JIRA** and:
|
||||
|
||||
1. Tick the active check box to enable the service
|
||||
1. Supply the URL to JIRA server, for example http://jira.example.com
|
||||
1. Supply the username of a user we created under `Configuring JIRA` section,
|
||||
for example `gitlab`
|
||||
1. Supply the password of the user
|
||||
1. Optional: supply the JIRA API version, default is version `2`
|
||||
1. Optional: supply the JIRA issue transition ID (issue transition to closed).
|
||||
This is dependent on JIRA settings, default is `2`
|
||||
1. Hit save
|
||||
|
||||
|
||||
|
||||
|
||||
[services-templates]: ../project_services/services_templates.md
|
||||
[jira-gitlab-yml]: https://gitlab.com/subscribers/gitlab-ee/blob/6-8-stable-ee/config/gitlab.yml.example#L111-115
|
||||
This document was moved under [project_services/jira](../project_services/jira.md).
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 103 KiB |
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 119 KiB After Width: | Height: | Size: 119 KiB |
@@ -0,0 +1,212 @@
|
||||
# GitLab JIRA integration
|
||||
|
||||
GitLab can be configured to interact with [JIRA Core] either using an
|
||||
on-premises instance or the SaaS solution that Atlassian offers. Configuration
|
||||
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
|
||||
case you have a single JIRA instance, you can pre-fill the JIRA service
|
||||
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
|
||||
|
||||
The configuration consists of two parts:
|
||||
|
||||
- [JIRA configuration](#configuring-jira)
|
||||
- [GitLab configuration](#configuring-gitlab)
|
||||
|
||||
### Configuring JIRA
|
||||
|
||||
First things first, we need to create a user in JIRA which will have access to
|
||||
all projects that need to integrate with GitLab.
|
||||
|
||||
We have split this stage in steps so it is easier to follow.
|
||||
|
||||
---
|
||||
|
||||
1. Login to your JIRA instance as an administrator and under **Administration**
|
||||
go to **User Management** to create a new user.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
1. The next step is to create a new user (e.g., `gitlab`) who has write access
|
||||
to projects in JIRA. Enter the user's name and a _valid_ e-mail address
|
||||
since JIRA sends a verification e-mail to set-up the password.
|
||||
_**Note:** JIRA creates the username automatically by using the e-mail
|
||||
prefix. You can change it later if you want._
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
1. Now, let's create a `gitlab-developers` group which will have write access
|
||||
to projects in JIRA. Go to the **Groups** tab and select **Create group**.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
Give it an optional description and hit **Create group**.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
1. Give the newly-created group write access by going to
|
||||
**Application access > View configuration** and adding the `gitlab-developers`
|
||||
group to JIRA Core.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
1. Add the `gitlab` user to the `gitlab-developers` group by going to
|
||||
**Users > GitLab user > Add group** and selecting the `gitlab-developers`
|
||||
group from the dropdown menu. Notice that the group says _Access_ which is
|
||||
what we aim for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
The JIRA configuration is over. Write down the new JIRA username and its
|
||||
password as they will be needed when configuring GitLab in the next section.
|
||||
|
||||
### Configuring GitLab
|
||||
|
||||
_**Note:** The currently supported JIRA versions are v6.x and v7.x. and GitLab
|
||||
7.8 or higher is required._
|
||||
|
||||
---
|
||||
|
||||
Assuming you [have already configured JIRA](#configuring-jira), now it's time
|
||||
to configure GitLab.
|
||||
|
||||
JIRA configuration in GitLab is done via a project's
|
||||
[**Services**](../project_services/project_services.md).
|
||||
|
||||
To enable JIRA integration in a project, navigate to the project's
|
||||
**Settings > Services > JIRA**.
|
||||
|
||||
Fill in the required details on the page, as described in the table below.
|
||||
|
||||
| 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). |
|
||||
| `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](img/jira_issues_workflow.png)). By default, this ID is set to `2` |
|
||||
|
||||
After saving the configuration, your GitLab project will be able to interact
|
||||
with the linked JIRA project.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
If you reference a JIRA issue, e.g., `GITLAB-1`, in a commit comment, a link
|
||||
which points back to JIRA is created.
|
||||
|
||||
The same works for comments in merge requests as well.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
The mentioning action is two-fold, so a comment with a JIRA issue in GitLab
|
||||
will automatically add a comment in that particular JIRA issue with the link
|
||||
back to GitLab.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
The comment on the JIRA issue is of the form:
|
||||
|
||||
> 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
|
||||
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:
|
||||
|
||||
- `Resolves GITLAB-1`
|
||||
- `Closes GITLAB-1`
|
||||
- `Fixes GITLAB-1`
|
||||
|
||||
where `GITLAB-1` the issue ID of the JIRA project.
|
||||
|
||||
### JIRA issue closing example
|
||||
|
||||
Let's say for example that we submitted a bug fix and created a merge request
|
||||
in GitLab. The workflow would be something like this:
|
||||
|
||||
1. Create a new branch
|
||||
1. Fix the bug
|
||||
1. Commit the changes and push branch to GitLab
|
||||
1. Open a new merge request and reference the JIRA issue including one of the
|
||||
trigger words, e.g.: `Fixes GITLAB-1`, in the description
|
||||
1. Submit the merge request
|
||||
1. Ask someone to review
|
||||
1. Merge the merge request
|
||||
1. The JIRA issue is automatically closed
|
||||
|
||||
---
|
||||
|
||||
In the following screenshot you can see what the link references to the JIRA
|
||||
issue look like.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
Once this merge request is merged, the JIRA issue will be automatically closed
|
||||
with a link to the commit that resolved the issue.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
You can see from the above image that there are four references to GitLab:
|
||||
|
||||
- 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"
|
||||
@@ -22,7 +22,7 @@ further configuration instructions and details. Contributions are welcome.
|
||||
| Gemnasium | Gemnasium monitors your project dependencies and alerts you about updates and security vulnerabilities |
|
||||
| [HipChat](hipchat.md) | Private group chat and IM |
|
||||
| [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway |
|
||||
| JIRA | Jira issue tracker |
|
||||
| [JIRA](jira.md) | JIRA issue tracker |
|
||||
| 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 |
|
||||
|
||||
Reference in New Issue
Block a user