diff options
Diffstat (limited to 'doc/integration/jira/development_panel.md')
| -rw-r--r-- | doc/integration/jira/development_panel.md | 110 |
1 files changed, 53 insertions, 57 deletions
diff --git a/doc/integration/jira/development_panel.md b/doc/integration/jira/development_panel.md index a03507c4e19..f8c37394f85 100644 --- a/doc/integration/jira/development_panel.md +++ b/doc/integration/jira/development_panel.md @@ -8,29 +8,46 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/233149) from GitLab Premium to GitLab Free in 13.4. -The Jira development panel connects all GitLab projects in a group or personal namespace -where you can view GitLab activity. +You can use the Jira development panel to view GitLab activity for a Jira issue directly in Jira. +To set up the Jira development panel: -When you're in GitLab, you can refer to a Jira issue by ID. -The [activity for that issue](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/) -is displayed in the Jira development panel. +- **For Jira Cloud**, use the [GitLab for Jira Cloud app](connect-app.md) developed by GitLab. +- **For Jira Data Center or Jira Server**, use the [Jira DVCS connector](dvcs/index.md) developed by Atlassian. -In the Jira development panel, you can create a GitLab merge request from a branch. -You can also create a GitLab branch from a Jira issue in the GitLab for Jira Cloud app -([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66032) in GitLab 14.2). +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +For an overview, see [Jira development panel integration](https://www.youtube.com/watch?v=VjVTOmMl85M). + +## Feature availability + +This table shows the features available with the Jira DVCS connector and the GitLab for Jira Cloud app: + +| Feature | Jira DVCS connector | GitLab for Jira Cloud app | +|---------------------|------------------------|---------------------------| +| Smart Commits | **{check-circle}** Yes | **{check-circle}** Yes | +| Sync merge requests | **{check-circle}** Yes | **{check-circle}** Yes | +| Sync branches | **{check-circle}** Yes | **{check-circle}** Yes | +| Sync commits | **{check-circle}** Yes | **{check-circle}** Yes | +| Sync existing data | **{check-circle}** Yes | **{check-circle}** Yes | +| Sync builds | **{dotted-circle}** No | **{check-circle}** Yes | +| Sync deployments | **{dotted-circle}** No | **{check-circle}** Yes | +| Sync feature flags | **{dotted-circle}** No | **{check-circle}** Yes | +| Sync interval | Up to 60 minutes | Real time | +| Create branches | **{dotted-circle}** No | **{check-circle}** Yes (GitLab SaaS only) | +| Create merge request from branch | **{check-circle}** Yes | **{check-circle}** Yes | +| Create branch from Jira issue | **{dotted-circle}** No | **{check-circle}** Yes ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66032) in GitLab 14.2) | ## Connected projects in GitLab -The Jira development panel connects to the entire Jira instance all GitLab projects in: +The Jira development panel connects a Jira instance with all its projects to the following: -- A top-level group, including all projects in its subgroups. -- A personal namespace. +- **For the [GitLab for Jira Cloud app](connect-app.md)**, linked GitLab groups or subgroups and their projects +- **For the [Jira DVCS connector](dvcs/index.md)**, linked GitLab groups, subgroups, or personal namespaces and their projects -These GitLab projects can interact with all Jira projects in that instance. +## Information displayed in the development panel -## Information displayed in the panel +You can [view GitLab activity for a Jira issue](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/) in the Jira development panel by referring to the Jira issue by ID in GitLab. -The information displayed in the Jira development panel depends on where you mention the Jira issue ID in GitLab. +The information displayed in the development panel depends on where you mention the Jira issue ID in GitLab. | GitLab: where you mention the Jira issue ID | Jira development panel: what information is displayed | |------------------------------------------------|-------------------------------------------------------| @@ -41,58 +58,37 @@ The information displayed in the Jira development panel depends on where you men ## Jira Smart Commits +Prerequisites: + +- You must have GitLab and Jira user accounts with the same email address or username. +- The commands must be in the first line of the commit message. +- The commit message must not span more than one line. + Jira Smart Commits are special commands to process a Jira issue. With these commands, you can use GitLab to: - Add a custom comment to a Jira issue. - Log time against a Jira issue. - Transition a Jira issue to any status defined in the project workflow. -For more information, see the -[Atlassian documentation](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html). - -## Configure the panel +### Smart Commit syntax -<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> -For an overview, see [Jira development panel integration](https://www.youtube.com/watch?v=VjVTOmMl85M). - -### For GitLab.com - -Prerequisite: - -- You must have at least the Maintainer role for the group. - -To configure the Jira development panel on GitLab.com: - -- **For [Jira Cloud](https://www.atlassian.com/migration/assess/why-cloud)**: - - [From the Atlassian Marketplace, install the GitLab for Jira Cloud app](https://marketplace.atlassian.com/apps/1221011/gitlab-for-jira-cloud?hosting=cloud&tab=overview). - - This method syncs data between GitLab.com and Jira in real time. - - This method requires inbound connections for the setup and outbound connections to push data to Jira. - - For more information, see [GitLab for Jira Cloud app](connect-app.md). -- **For Jira Server**: - - Use the [Jira DVCS connector](dvcs/index.md). - - This method syncs data every hour and works only with inbound connections. - - This method attempts to set up webhooks in GitLab to sync data in real time, which requires outbound connections. - -### For self-managed GitLab - -Prerequisites: +Smart Commits must follow this syntax: -- You must have administrator access to the instance. -- Your GitLab installation must not use a [relative URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configure-a-relative-url-for-gitlab) - (for example, `https://example.com/gitlab`). +```plaintext +<ISSUE_KEY> <ignored text> #<command> <optional command parameters> +``` -To configure the Jira development panel on self-managed GitLab: +You can execute one or more commands in a single commit. -- **For [Jira Cloud](https://www.atlassian.com/migration/assess/why-cloud)**: - - [Install the GitLab for Jira Cloud app manually](connect-app.md#install-the-gitlab-for-jira-cloud-app-manually). - - This method requires inbound connections for the setup and outbound connection to push data to Jira. - - For more information, see [Connect the GitLab for Jira Cloud app for self-managed instances](connect-app.md#connect-the-gitlab-for-jira-cloud-app-for-self-managed-instances). -- **For Jira Server**: - - Use the [Jira DVCS connector](dvcs/index.md). - - This method syncs data every hour and works only with inbound connections. - - This method attempts to set up webhooks in GitLab to sync data in real time, which requires outbound connections. +| Commands | Syntax | +|-------------------------------------------------|--------------------------------------------------------------| +| Add a comment | `KEY-123 #comment Bug is fixed` | +| Log time | `KEY-123 #time 2w 4d 10h 52m Tracking work time` | +| Close an issue | `KEY-123 #close Closing issue` | +| Log time and close an issue | `KEY-123 #time 2d 5h #close` | +| Add a comment and transition to **In-progress** | `KEY-123 #comment Started working on the issue #in-progress` | -## Troubleshooting +For more information about how Smart Commits work and what commands are available to use, see: -To troubleshoot the Jira development panel on your own server, see the -[Atlassian documentation](https://confluence.atlassian.com/jirakb/troubleshoot-the-development-panel-in-jira-server-574685212.html). +- [Process issues with Smart Commits](https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/) +- [Using Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html) |