GitLab.com for Jira Cloud app

You can integrate GitLab and Jira Cloud using the GitLab.com for Jira Cloud app in the Atlassian Marketplace.

Only Jira users with administrator access can install or configure the GitLab.com for Jira Cloud app.

Install the GitLab.com for Jira Cloud app

If you use GitLab.com and Jira Cloud, you can install the GitLab.com for Jira Cloud app. If you do not use both of these environments, use the Jira DVCS Connector or install GitLab.com for Jira Cloud app for self-managed instances. We recommend the GitLab.com for Jira Cloud app, because data is synchronized in real time. The DVCS connector updates data only once per hour.

To configure the GitLab.com for Jira Cloud app, you must have at least the Maintainer role in the GitLab.com namespace.

This integration method supports Smart Commits.

For a walkthrough of the integration with GitLab.com for Jira Cloud app, watch Configure GitLab.com Jira Could Integration using Marketplace App on YouTube.

To install the GitLab.com for Jira Cloud app:

  1. In Jira, go to Jira Settings > Apps > Find new apps, then search for GitLab.

  2. Select GitLab.com for Jira Cloud, then select Get it now, or go to the App in the marketplace directly.

    Install GitLab.com app on Jira Cloud

  3. After installing, to go to the configurations page, select Get started. This page is always available under Jira Settings > Apps > Manage apps.

    Start GitLab.com app configuration on Jira Cloud

  4. To add namespaces, ensure you’re signed in to GitLab.com as a user with at least the Maintainer role.

    Sign in to GitLab.com in GitLab.com for Jira Cloud app

  5. To open the list of available namespaces, select Add namespace.

  6. Identify the namespace you want to link, and select Link.
    • You must have at least the Maintainer role for the namespace.
    • Only Jira site administrators can add or remove namespaces for an installation.

    Link namespace in GitLab.com for Jira Cloud app

note
The GitLab.com user only needs access when adding a new namespace. For syncing with Jira, we do not depend on the user’s token.

After a namespace is added:

  • All future commits, branches, and merge requests of all projects under that namespace are synced to Jira.
  • From GitLab 13.8, past merge request data is synced to Jira.

Support for syncing past branch and commit data is tracked in this issue.

Update the GitLab.com for Jira Cloud app

Most updates to the app are fully automated and don’t require any user interaction. See the Atlassian Marketplace documentation for details.

If the app requires additional permissions, the update must first be manually approved in Jira.

Connect the GitLab.com for Jira Cloud app for self-managed instances

Introduced in GitLab 15.7.

Prerequisites:

  • GitLab.com must serve as a proxy for the instance.
  • The instance must be publicly available.
  • The instance must be on version 15.7 or later.

You can link self-managed instances after installing the GitLab.com for Jira Cloud app from the marketplace. Jira apps can only link to one URL per marketplace listing. The official listing links to GitLab.com.

It’s not possible to create branches from Jira for self-managed instances.

Set up your instance

To set up your self-managed instance for the GitLab.com for Jira Cloud app in GitLab 15.7 or later:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Applications (/admin/applications).
  3. Select New application.
  4. In Redirect URI, enter https://gitlab.com/-/jira_connect/oauth_callbacks.
  5. Ensure the Trusted and Confidential checkboxes are cleared.
  6. In Scopes, select the api checkbox only.
  7. Select Save application.
  8. Copy the Application ID value.
  9. On the left sidebar, select Settings > General (/admin/application_settings/general).
  10. Expand the GitLab for Jira App section.
  11. Paste the Application ID value into Jira Connect Application ID.
  12. In Jira Connect Proxy URL, enter https://gitlab.com.
  13. Select Save changes.

To link your self-managed instance to the GitLab.com for Jira Cloud app:

  1. Install the GitLab.com for Jira Cloud app.
  2. Select GitLab (self-managed).
  3. Enter your GitLab instance URL.
  4. Select Save.

Install the GitLab.com for Jira Cloud app for self-managed instances

If your GitLab instance is self-managed, you must follow some extra steps to install the GitLab.com for Jira Cloud app, and your GitLab instance must be accessible by Jira.

Each Jira Cloud application must be installed from a single location. Jira fetches a manifest file from the location you provide. The manifest file describes the application to the system. To support self-managed GitLab instances with Jira Cloud, you can either:

Install the application manually

You can configure your Atlassian Cloud instance to allow you to install applications from outside the Marketplace, which allows you to install the application:

  1. Sign in to your Jira instance as an administrator.
  2. Place your Jira instance into development mode.
  3. Sign in to your GitLab application as a user with administrator access.
  4. Install the GitLab application from your Jira instance, as described in the Atlassian developer guides:

    1. In your Jira instance, go to Apps > Manage Apps and select Upload app:

      Button labeled "upload app"

    2. For App descriptor URL, provide the full URL to your manifest file, based on your instance configuration. By default, your manifest file is located at /-/jira_connect/app_descriptor.json. For example, if your GitLab self-managed instance domain is app.pet-store.cloud, your manifest file is located at https://app.pet-store.cloud/-/jira_connect/app_descriptor.json.
    3. Select Upload. Jira fetches the content of your app_descriptor file and installs it.

    4. If the upload is successful, Jira displays a modal panel: Installed and ready to go! To configure the integration, select Get started.

      Success modal

  5. Disable development mode on your Jira instance.

The GitLab.com for Jira Cloud app now displays under Manage apps. You can also select Get started to open the configuration page rendered from your GitLab instance.

note
If a GitLab update makes changes to the application descriptor, you must uninstall, then reinstall the application.

Create a Marketplace listing

If you prefer to not use development mode on your Jira instance, you can create your own Marketplace listing for your instance. This enables your application to be installed from the Atlassian Marketplace.

For full instructions, review the Atlassian guide to creating a marketplace listing. To create a Marketplace listing:

  1. Register as a Marketplace vendor.
  2. List your application using the application descriptor URL.
    • Your manifest file is located at: https://your.domain/your-path/-/jira_connect/app_descriptor.json
    • We recommend you list your application as private, because public applications can be viewed and installed by any user.
  3. Generate test license tokens for your application.
note
This method uses automated updates the same way as our GitLab.com Marketplace listing.

Troubleshooting

Browser displays a sign-in message when already signed in

You might get the following message prompting you to sign in to GitLab.com when you’re already signed in: 

You need to sign in or sign up before continuing.

The GitLab.com for Jira Cloud app uses an iframe to add namespaces on the settings page. Some browsers block cross-site cookies, which can lead to this issue.

To resolve this issue, use either Firefox or Chrome or enable cross-site cookies in your browser.

Manual installation fails

You might get an error if you have installed the GitLab.com for Jira Cloud app from the official marketplace listing and replaced it with manual installation. To resolve this issue, disable the Jira Connect Proxy URL setting.

  • In GitLab 15.7:

    1. Open a Rails console.
    2. Execute ApplicationSetting.current_without_cache.update(jira_connect_proxy_url: nil).

  • In GitLab 15.8 and later:

    1. On the top bar, select Main menu > Admin.
    2. On the left sidebar, select Settings > General (/admin/application_settings/general).
    3. Expand the GitLab for Jira App section.
    4. Clear the Jira Connect Proxy URL text box.
    5. Select Save changes.