kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/integration/jira/connect-app.md

6.5 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 for Jira app (FREE SAAS)

You can integrate GitLab.com and Jira Cloud using the GitLab for Jira app in the Atlassian Marketplace. The user configuring GitLab for Jira must have Maintainer permissions in the GitLab namespace.

This method is recommended when using GitLab.com and Jira Cloud because data is synchronized in real-time. The DVCS connector updates data only once per hour. If you are not using both of these environments, use the Jira DVCS Connector method.

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

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

  2. Click GitLab for Jira, then click Get it now, or go to the App in the marketplace directly.

    Install GitLab App on Jira

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

    Start GitLab App configuration on Jira

  4. If not already signed in to GitLab.com, you must sign in as a user with Maintainer permissions to add namespaces.

    Sign in to GitLab.com in GitLab Jira App

  5. Select Add namespace to open the list of available namespaces.

  6. Identify the namespace you want to link, and select Link.

    Link namespace in GitLab Jira App

NOTE: The GitLab 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 planned.

For more information, see Usage.

Install the GitLab Jira Cloud application for self-managed instances (FREE SELF)

If your GitLab instance is self-managed, you must follow some extra steps to install the GitLab Jira Cloud application.

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 (FREE SELF)

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 a user with administrator permissions.

  2. Place your Jira instance into development mode.

  3. Sign in to your GitLab application as a user with Administrator permissions.

  4. Install the GitLab application from your self-managed GitLab instance, as described in the Atlassian developer guides).

  5. In your Jira instance, go to Apps > Manage Apps and click Upload app:

    Image showing button labeled "upload app"

  6. For App descriptor URL, provide full URL to your manifest file, modifying this URL based on your instance configuration: https://your.domain/your-path/-/jira_connect/app_descriptor.json

  7. Click Upload, and Jira fetches the content of your app_descriptor file and installs it for you.

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

    Image showing success modal

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

NOTE: If you make changes to the application descriptor, you must uninstall, then reinstall, the application.

Create a Marketplace listing (FREE SELF)

If you prefer to not use development mode on your Jira instance, you can create your own Marketplace listing for your instance, which 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, you must:

  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
    • GitLab recommends 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.

Review the official Atlassian documentation for details.

NOTE: DVCS means distributed version control system.

Troubleshooting GitLab for Jira

The GitLab for Jira App uses an iframe to add namespaces on the settings page. Some browsers block cross-site cookies. This can lead to a message saying that the user needs to log in on GitLab.com even though the user is already logged in.

"You need to sign in or sign up before continuing."

In this case, use Firefox or enable cross-site cookies in your browser.