Code Studio

Integrating Code Studio with Jira

Setting up the Jira integration

Prerequisites

The following are the prerequisites for setting up the Jira integration:

  • A user account on Jira Cloud

  • A Jira Cloud API token

Creating a Jira Cloud API token

To create a token:

  1. Log in to an Atlassian account that has write access to Jira projects.

  2. Use one of the following steps to access the API Tokens page:

  3. Click Create API token.

    The system displays the Create an API token dialog box.

  4. In Label, enter a label for your token and click Create.

  5. Click Copy to copy the token.

Connecting to Code Studio

  1. Log in to Code Studio.

  2. On the left sidebar, click Search or go to and find your project.

  3. On your project page, click Settings.

  4. In the left navigation page, click Integrations.

    The system displays the Integrations page.

  5. In the Add an integration section, click Jira.

  6. In the Connection details section, do the following:

    1. In Web URL, enter the base URL for the Jira instance web interface that you want to link to this Code Studio project. For example, https://jira.example.com.

    2. In Jira API URL, enter the base URL for the Jira instance API. For example, https://jira-api.example.com.

      If you do not set the URL, the default value is Web URL. For Jira Cloud, leave this field blank.

    3. In Authentication method, select Basic.

    4. In Email or username, enter your Jira Cloud email address.

    5. In API token or password, enter the API token for Jira Cloud that you copied in Creating a Jira Cloud API token.

  7. In the Trigger section, do the following:

    1. Select the Commit, Merge request, or both checkboxes.

      When you specify a Jira issue ID in a commit or merge request, Code Studio links to the issue.

    2. To enable commenting in the Jira issue that links back to Code Studio, select the Enable comments checkbox.

      The system displays the Comment detail sub-section with Standard and All details options. You can choose one of the options based on what details you want the comment to display.

    3. To configure automatic issue transitions in Code Studio, select the Enable Jira transitions checkbox.

  8. (Optional) In the Jira issue matching section, do the following if you need to configure custom rules for Jira issue key matching:

    1. In Jira issue regex, enter a regex pattern.

    2. In Jira issue prefix, enter a prefix.

  9. (Optional) To test the Jira integration settings, click Test settings.

  10. Click Save changes.

  11. In the left navigation page, click Plan > Issues.

  12. Click Import issues and select Import from Jira.

Your Code Studio project can now interact with all Jira projects in your instance. The project displays a Jira link that opens the Jira project.

Setting up the Jira development panel

Prerequisites

The following are the prerequisites for setting up the Jira development panel:

  • You must use Jira Cloud.

  • The user who sets up the Jira integration must have the Code Studio role of Owner or Maintainer, and must adhere to Jira user requirements.

Completing the integration

  1. Add the GitLab for Jira Cloud application to your Jira instance from the Atlassian Marketplace.

  2. Select GitLab (self-managed) as the GitLab version.

    You do not need to be a GitLab administrator.

  3. Click Next.

  4. On the next screen, select all the checkboxes:

    • Prerequisites

    • Set up OAuth authentication

    • Set up your instance

    • Jira user requirements

    Acquia performs the first three steps. The Jira user requirements step must be completed by your Jira user.

  5. In GitLab instance URL, enter https://code.acquia.com and click Save.

  6. Click Sign in to https://code.acquia.com.

  7. Click Authorize to allow Jira Cloud access to your Code Studio account.

  8. If you do not see a screen to link groups, click Link groups.

    The system displays the Link groups dialog box.

  9. Click Link next to your Acquia Subscription group to complete the integration.

For information about data that Code Studio synced to Jira, see GitLab data synced to Jira. For a complete list of features, see Feature availability.