gitlab-org--gitlab-foss/doc/integration/jira/index.md

5.2 KiB

stage group info
Create Ecosystem 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

GitLab Jira Development panel integration (FREE)

  • Moved to GitLab Free in 13.4.

The Jira Development panel integration allows you to reference Jira issues in GitLab, displaying activity in the Development panel in the issue.

It complements the GitLab Jira integration. You may choose to configure both integrations to take advantage of both sets of features. See a feature comparison.

Features

Your mention of Jira issue ID in GitLab context Automated effect in Jira issue
In a merge request Link to the MR is displayed in Development panel.
In a branch name Link to the branch is displayed in Development panel.
In a commit message Link to the commit is displayed in Development panel.
In a commit message with Jira Smart Commit format Displays your custom comment or logged time spent and/or performs specified issue transition on merge.

With this integration, you can access related GitLab merge requests, branches, and commits directly from a Jira issue, reflecting your work in GitLab. From the Development panel, you can open a detailed view and take actions including creating a new merge request from a branch. For more information, see Usage.

This integration connects all GitLab projects to projects in the Jira instance in either:

  • A top-level group. A top-level GitLab group is one that does not have any parent group itself. All the projects of that top-level group, as well as projects of the top-level group's subgroups nesting down, are connected.
  • A personal namespace, which then connects the projects in that personal namespace to Jira.

This differs from the Jira integration, where the mapping is between one GitLab project and the entire Jira instance.

Configuration

For an overview of how to configure Jira Development panel integration, see Agile Management - GitLab Jira Development panel integration.

We recommend that a GitLab group maintainer or group owner, or instance administrator (in the case of self-managed GitLab) set up the integration to simplify administration.

If you use Jira on: GitLab.com customers need: GitLab self-managed customers need:
Atlassian cloud The GitLab.com for Jira Cloud application installed from the Atlassian Marketplace. This offers real-time sync between GitLab and Jira. The GitLab.com for Jira Cloud, using a workaround process. See the documentation for installing the GitLab Jira Cloud application for self-managed instances for more information.
Your own server The Jira DVCS (distributed version control system) connector. This syncs data hourly. The Jira DVCS Connector.

Usage

After the integration is set up on GitLab and Jira, you can:

  • Refer to any Jira issue by its ID in GitLab branch names, commit messages, and merge request titles.
  • See the linked branches, commits, and merge requests in Jira issues (merge requests are called "pull requests" in Jira issues).

Jira issue IDs must be formatted in uppercase for the integration to work.

Branch, Commit and Pull Requests links on Jira issue

Click the links to see your GitLab repository data.

GitLab commits details on a Jira issue

GitLab merge requests details on a Jira issue

For more information on using Jira Smart Commits to track time against an issue, specify an issue transition, or add a custom comment, see the Atlassian page Using Smart Commits.

Limitations

This integration is not supported on GitLab instances under a relative URL. For example, http://example.com/gitlab.