connect-app.md

stage: Manage
group: Import and Integrate
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments

GitLab for Jira Cloud app

DETAILS: Tier: Free, Premium, Ultimate Offering: SaaS, self-managed

NOTE: This page contains user documentation for the GitLab for Jira Cloud app. For administrator documentation, see GitLab for Jira Cloud app administration.

With the GitLab for Jira Cloud app, you can connect GitLab and Jira Cloud to sync development information in real time. You can view this information in the Jira development panel.

You can use the GitLab for Jira Cloud app to link top-level groups or subgroups. It's not possible to directly link projects or personal namespaces.

To set up the GitLab for Jira Cloud app on GitLab.com, install the GitLab for Jira Cloud app.

After you set up the app, you can use the project toolchain developed and maintained by Atlassian to link GitLab repositories to Jira projects. The project toolchain does not affect how development information is synced between GitLab and Jira Cloud.

For Jira Data Center or Jira Server, use the Jira DVCS connector developed and maintained by Atlassian.

GitLab data synced to Jira

After you link a group, the following GitLab data is synced to Jira for all projects in that group when you mention a Jira issue ID:

• Existing project data (before you linked the group):
  • The last 400 merge requests
  • The last 400 branches and the last commit to each of those branches (GitLab 15.11 and later)
• New project data (after you linked the group):
  • Merge requests
  • Branches
  • Commits
  • Builds
  • Deployments
  • Feature flags

Install the GitLab for Jira Cloud app

DETAILS: Tier: Free, Premium, Ultimate Offering: SaaS

Prerequisites:

• You must have site administrator access to the Jira instance.
• Your network must allow inbound and outbound connections between GitLab and Jira.

To install the GitLab for Jira Cloud app:

1. In Jira, on the top bar, select Apps > Explore more apps and search for GitLab for Jira Cloud.
2. Select GitLab for Jira Cloud, then select Get it now.

Alternatively, get the app directly from the Atlassian Marketplace.

You can now configure the GitLab for Jira Cloud app.

For an overview, see Configure the GitLab for Jira Cloud app from the Atlassian Marketplace.

Configure the GitLab for Jira Cloud app

DETAILS: Tier: Free, Premium, Ultimate Offering: SaaS

• Add namespace renamed to Link groups in GitLab 16.1.

Prerequisites:

• You must have at least the Maintainer role for the GitLab group.
• The Jira user that installs and configures the GitLab for Jira Cloud app must meet certain requirements.

You can sync data from GitLab to Jira by linking the GitLab for Jira Cloud app to one or more GitLab groups. To configure the GitLab for Jira Cloud app:

1. In Jira, on the top bar, select Apps > Manage your apps.
2. Expand GitLab for Jira (GitLab.com).
3. Select Get started.
4. Optional. To set the GitLab instance to use with Jira, select Change GitLab version.
5. Select Sign in to GitLab.
6. For a list of groups you can link to, select Link groups.
7. To link to a group, select Link.

After you link to a GitLab group, data is synced to Jira for all projects in that group. The initial data sync happens in batches of 20 projects per minute. For groups with many projects, the data sync for some projects is delayed.

Update the GitLab for Jira Cloud app

Most updates to the app are automatic. For more information, see the Atlassian documentation.

If the app requires additional permissions, you must manually approve the update in Jira.

Security considerations

The GitLab for Jira Cloud app connects GitLab and Jira. Data must be shared between the two applications, and access must be granted in both directions.

Access to Jira through access token

Jira shares an access token with GitLab to authenticate and authorize data pushes to Jira. As part of the app installation process, Jira sends a handshake request to GitLab containing the access token. The handshake is signed with an asymmetric JWT, and the access token is stored encrypted with AES256-GCM on GitLab.

Troubleshooting

When working with the GitLab for Jira Cloud app, you might encounter the following issues.

For administrator documentation, see GitLab for Jira Cloud app administration.

Error when connecting the app

When you connect the GitLab for Jira Cloud app, you might get this error:

Failed to link group. Please try again.

A 403 Forbidden is returned if the user information cannot be fetched from Jira because of insufficient permissions.

To resolve this issue, ensure the Jira user that installs and configures the app meets certain requirements.