6.8 KiB
| stage | group | info |
|---|---|---|
| Ecosystem | Integrations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments |
Jira integrations (FREE)
If your organization uses Jira issues, you can migrate your issues from Jira (PREMIUM) and work exclusively in GitLab. However, if you'd like to continue to use Jira, you can integrate it with GitLab. GitLab offers two types of Jira integrations, and you can use one or both depending on the capabilities you need. It is recommended that you enable both.
Compare integrations
After you set up one or both of these integrations, you can cross-reference activity in your GitLab project with any of your projects in Jira.
Jira integration
This integration connects one or more GitLab projects to a Jira instance. The Jira instance
can be hosted by you or in Atlassian cloud.
The supported Jira versions are v6.x, v7.x, and v8.x.
For an overview, see Agile Management - GitLab-Jira Basic Integration.
To set up the integration, configure the project settings in GitLab. You can also configure these settings at a group level, and for self-managed GitLab, at an instance level.
Jira development panel integration
The Jira development panel integration connects all GitLab projects under a group or personal namespace. When configured, relevant GitLab information, including related branches, commits, and merge requests, displays in the development panel.
To set up the Jira development panel integration:
- If your installation uses Jira Cloud, use the GitLab for Jira app.
- If either your Jira or GitLab installation is self-managed, use the Jira DVCS (distributed version control system) connector.
Direct feature comparison
| Capability | Jira integration | Jira Development panel integration |
|---|---|---|
| Mention a Jira issue ID in a GitLab commit or merge request, and a link to the Jira issue is created. | Yes. | No. |
| Mention a Jira issue ID in GitLab and the Jira issue shows the GitLab issue or merge request. | Yes. A Jira comment with the GitLab issue or MR title links to GitLab. The first mention is also added to the Jira issue under Web links. | Yes, in the issue's development panel. |
| Mention a Jira issue ID in a GitLab commit message and the Jira issue shows the commit message. | Yes. The entire commit message is displayed in the Jira issue as a comment and under Web links. Each message links back to the commit in GitLab. | Yes, in the issue's development panel and optionally with a custom comment on the Jira issue using Jira Smart Commits. |
| Mention a Jira issue ID in a GitLab branch name and the Jira issue shows the branch name. | No. | Yes, in the issue's development panel. |
| Add Jira time tracking to an issue. | No. | Yes. Time can be specified using Jira Smart Commits. |
| Use a Git commit or merge request to transition or close a Jira issue. | Yes. Only a single transition type, typically configured to close the issue by setting it to Done. | Yes. Transition to any state using Jira Smart Commits. |
| Display a list of Jira issues. | Yes. (PREMIUM) | No. |
| Create a Jira issue from a vulnerability or finding. | Yes. (ULTIMATE) | No. |
| Create a GitLab branch from a Jira issue. | No. | Yes, in the issue's development panel. |
Authentication in Jira
The process for configuring Jira depends on whether you host Jira on your own server or on Atlassian cloud:
- Jira Server supports basic authentication. When connecting, a username and password are required. Connecting to Jira Server via CAS is not possible. For more information, read how to set up a user in Jira Server.
- Jira on Atlassian cloud supports authentication through an API token. When connecting to Jira on Atlassian cloud, an email and API token are required. For more information, read set up a user in Jira on Atlassian cloud.
Privacy considerations
If you integrate a private GitLab project with Jira using the Jira integration, actions in GitLab issues and merge requests linked to a Jira issue leak information about the private project to non-administrator Jira users. If your installation uses Jira Cloud, you can use the GitLab.com for Jira Cloud app to avoid this risk.
Troubleshooting
If these features do not work as expected, it is likely due to a problem with the way the integration settings were configured.
GitLab is unable to comment on a Jira issue
If GitLab cannot comment on Jira issues, make sure the Jira user you set up for the integration has permission to:
- Post comments on a Jira issue.
- Transition the Jira issue.
Jira issue references and update comments do not work if the GitLab issue tracker is disabled.
GitLab is unable to close a Jira issue
Make sure the Transition ID you set in the Jira settings matches the one
your project needs to close an issue.
Make sure that the Jira issue is not already marked as resolved. That is, the Jira issue resolution field is not set, and the issue is not struck through in Jira lists.
CAPTCHA
CAPTCHA may be triggered after several consecutive failed login attempts,
which may lead to a 401 unauthorized error when testing your Jira integration.
If CAPTCHA has been triggered, you can't use Jira's REST API to
authenticate with the Jira site.
To fix this error, sign in to your Jira instance and complete the CAPTCHA.
Third-party Jira integrations
Developers have built several third-party Jira integrations for GitLab that are listed on the Atlassian Marketplace.