debian-mirror-gitlab/doc/integration/jira/development_panel.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

103 lines
6.9 KiB
Markdown
Raw Normal View History

2021-04-29 21:17:54 +05:30
---
2022-11-25 23:54:43 +05:30
stage: Manage
2021-10-27 15:23:28 +05:30
group: Integrations
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-04-29 21:17:54 +05:30
---
2022-06-21 17:19:12 +05:30
# GitLab Jira development panel integration **(FREE)**
2021-04-29 21:17:54 +05:30
2022-08-13 15:12:31 +05:30
> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/233149) from GitLab Premium to GitLab Free in 13.4.
2021-04-29 21:17:54 +05:30
2022-06-21 17:19:12 +05:30
With the Jira development panel integration, you can reference Jira issues in GitLab.
2021-06-08 01:23:25 +05:30
When configured, activity (such as pipeline, deployment, and feature flags) displays in the Jira issue's
2022-06-21 17:19:12 +05:30
[development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/).
From the development panel, you can open a detailed view and
2021-06-08 01:23:25 +05:30
[take various actions](#use-the-integration), including creating a new merge request from a branch:
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
![Branch, Commit and Pull Requests links on Jira issue](img/jira_dev_panel_jira_setup_3.png)
2021-04-29 21:17:54 +05:30
2022-06-21 17:19:12 +05:30
The information displayed in the Jira development panel depends on where you mention the Jira issue ID:
2021-04-29 21:17:54 +05:30
| Your mention of Jira issue ID in GitLab context | Automated effect in Jira issue |
|---------------------------------------------------|--------------------------------------------------------------------------------------------------------|
2022-06-21 17:19:12 +05:30
| In a merge request title or description | Link to the MR is displayed in the development panel. |
| In a branch name | Link to the branch is displayed in the development panel. |
| In a commit message | Link to the commit is displayed in the development panel. |
2021-06-08 01:23:25 +05:30
| In a commit message with Jira [Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html) | Displays your custom comment or logged time spent and/or performs specified issue transition on merge. |
2021-04-29 21:17:54 +05:30
This integration connects all GitLab projects to projects in the Jira instance in either:
2021-06-08 01:23:25 +05:30
- A top-level GitLab group: Connects the projects in a group with no parent group,
including the projects in its subgroups.
- A personal namespace: Connects the projects in that personal namespace to Jira.
## Use the integration
After the integration is [set up on GitLab and Jira](#configure-the-integration), you can:
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
- Refer to any Jira issue by its ID (in uppercase) in GitLab branch names,
commit messages, and merge request titles.
2021-10-27 15:23:28 +05:30
- See the linked branches, commits, and merge requests in Jira issues.
2022-10-11 01:57:18 +05:30
- Create GitLab branches from Jira Cloud issues ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66032) in GitLab 14.2 for the GitLab for Jira app).
2021-04-29 21:17:54 +05:30
2021-09-30 23:02:18 +05:30
At this time, merge requests are called "pull requests" in Jira issues.
This name may change in a future Jira release.
2021-06-08 01:23:25 +05:30
Select the links to see your GitLab repository data.
![GitLab commits details on a Jira issue](img/jira_dev_panel_jira_setup_4.png)
![GitLab merge requests details on a Jira issue](img/jira_dev_panel_jira_setup_5.png)
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
### Use Jira Smart Commits
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
With Jira [Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html),
you can use GitLab to add Jira comments, log time spent on the issue, or apply any issue transition.
For more information about using Jira Smart Commits to track time against an issue, specify
an issue transition, or add a custom comment, read the Atlassian page
[Using Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html).
## Configure the integration
2021-04-29 21:17:54 +05:30
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
2022-06-21 17:19:12 +05:30
For an overview of how to configure the Jira development panel integration, see
[Agile Management - GitLab Jira development panel integration](https://www.youtube.com/watch?v=VjVTOmMl85M).
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
To simplify administration, we recommend that a GitLab group maintainer or group owner
2021-11-11 11:23:49 +05:30
(or, if possible, instance administrator in the case of self-managed GitLab) set up the integration.
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
| Jira usage | GitLab.com customers need | GitLab self-managed customers need |
|------------|---------------------------|------------------------------------|
2021-11-18 22:05:49 +05:30
| [Atlassian cloud](https://www.atlassian.com/migration/assess/why-cloud) | The [GitLab.com for Jira Cloud app](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?hosting=cloud&tab=overview) installed from the [Atlassian Marketplace](https://marketplace.atlassian.com). This offers real-time sync between GitLab.com and Jira. For more information, see the documentation for the [GitLab.com for Jira Cloud app](connect-app.md). | The [GitLab.com for Jira Cloud app](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?hosting=cloud&tab=overview), using a workaround process. See the documentation for [installing the GitLab.com for Jira Cloud app for self-managed instances](connect-app.md#install-the-gitlabcom-for-jira-cloud-app-for-self-managed-instances) for more information. |
2022-11-25 23:54:43 +05:30
| Your own server | The [Jira DVCS (distributed version control system) connector](dvcs.md). This syncs data hourly. | The [Jira DVCS (distributed version control system) connector](dvcs.md). This syncs data hourly. |
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
Each GitLab project can be configured to connect to an entire Jira instance. That means after
configuration, one GitLab project can interact with all Jira projects in that instance. For:
2021-04-29 21:17:54 +05:30
2021-11-18 22:05:49 +05:30
- The [view Jira issues](issues.md#view-jira-issues) feature, you must associate a GitLab project with a
2021-04-29 21:17:54 +05:30
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](../../user/admin_area/settings/project_integration_management.md).
2021-06-08 01:23:25 +05:30
## Limitations
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
- This integration is not supported on GitLab instances under a
[relative URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configure-a-relative-url-for-gitlab)
(for example, `http://example.com/gitlab`).
- [Creating a branch](https://gitlab.com/gitlab-org/gitlab/-/issues/2647) is only supported by the GitLab for Jira app and is not available within the DVCS integration. See [officially supported DVCS features](https://confluence.atlassian.com/adminjiraserver/integrating-with-development-tools-938846890.html) for more information.
2021-04-29 21:17:54 +05:30
2022-06-21 17:19:12 +05:30
## Troubleshoot the development panel
2021-12-11 22:18:48 +05:30
If you use Jira on your own server, go to the [Atlassian documentation](https://confluence.atlassian.com/jirakb/troubleshoot-the-development-panel-in-jira-server-574685212.html)
for general troubleshooting information.
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
### Cookies for Oracle's Access Manager
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
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`.