Pirate Praveen 2b1ea5b95e New upstream version 13.11.2+ds1

2021-04-29 21:17:54 +05:30

9.3 KiB

Raw Blame History

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.

Additional features provided by the Jira Development Panel integration include:

In a Jira issue, display relevant GitLab information in the development panel, including related branches, commits, and merge requests.
Use Jira Smart Commits in GitLab to add Jira comments, log time spent on the issue, or apply any issue transition.
Showing pipeline, deployment, and feature flags in Jira issues.

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.

Each GitLab project can be configured to connect to an entire Jira instance. That means one GitLab project can interact with all Jira projects in that instance, once configured. For:

The view Jira issues feature, you must associate a GitLab project with a specific Jira project.
Other features, you do not have to explicitly associate a GitLab project with any single Jira project.

If you have a single Jira instance, you can pre-fill the settings. For more information, read the documentation for central administration of project integrations.

To enable the Jira service in GitLab, you must:

Configure the project in Jira.
Enter the correct values in GitLab.

Configure GitLab

Notes:

The supported Jira versions are v6.x, v7.x, and v8.x.

In order to support Oracle's Access Manager, GitLab sends additional cookies to enable Basic Auth. The cookie being added to each request is OBBasicAuth with a value of fromDialog.

To enable the Jira integration in a project:

Go to the project's Integrations page and select the Jira service.
Select Enable integration.
Select Trigger actions. This determines whether a mention of a Jira issue in GitLab commits, merge requests, or both, should link the Jira issue back to that source commit/MR and transition the Jira issue, if indicated.
To include a comment on the Jira issue when the above reference is made in GitLab, select Enable comments.
To transition Jira issues when a closing reference is made in GitLab, select Enable Jira transitions.

Enter the further details on the page as described in the following table.

Field	Description
`Web URL`	The base URL to the Jira instance web interface which is being linked to this GitLab project. For example, `https://jira.example.com`.
`Jira API URL`	The base URL to the Jira instance API. Web URL value is used if not set. For example, `https://jira-api.example.com`. Leave this field blank (or use the same value of `Web URL`) if using Jira on Atlassian cloud.
`Username or Email`	Created in configure Jira step. Use `username` for Jira Server or `email` for Jira on Atlassian cloud.
`Password/API token`	Created in configure Jira step. Use `password` for Jira Server or `API token` for Jira on Atlassian cloud.

To enable users to view Jira issues inside the GitLab project, select Enable Jira issues and enter a Jira project key. (PREMIUM)

You can only display issues from a single Jira project within a given GitLab project.

WARNING: If you enable Jira issues with the setting above, all users that have access to this GitLab project are able to view all issues from the specified Jira project.
To enable creation of issues for vulnerabilities, select Enable Jira issues creation from vulnerabilities.
1. Select the Jira issue type. If the dropdown is empty, select refresh ({retry}) and try again.
To verify the Jira connection is working, select Test settings.
Select Save changes.

Your GitLab project can now interact with all Jira projects in your instance and the project now displays a Jira link that opens the Jira project.

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.

Click the links to see your GitLab repository data.

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.

9.3 KiB Raw Blame History