Documentation structure for LLMs (llms.txt)
CircleCI Logo

Connect Jira with CircleCI

17 days ago
Cloud

Integrate your CI/CD build and deployment status notifications directly into your Jira cards.

Connect your CircleCI jobs with Jira Cloud using:

Installation steps

Install the CircleCI for Jira app

  1. Go to the Atlassian Marketplace to install the CircleCI for Jira app.

    CircleCI for Jira app in Atlassian Marketplace
    Figure 1. CircleCI for Jira app in Atlassian Marketplace

  2. Install the app in the appropriate Jira Cloud instance. To do this, you must be a Jira Admin.

    Select organization
    Figure 2. Select organization
    Review and confirm app installation
    Figure 3. Review and confirm app installation

  3. Navigate to the configuration page by following these steps:

    1. Go to the Atlassian admin page.

    2. Ensure you have selected the appropriate organization (if you have more than one), and then select Products.

    3. For the appropriate Jira instance, select the ellipsis (Ellipsis menu iconEllipsis menu icon) icon.

    4. In the contextual menu, select Manage Jira apps.

      Manage apps menu
      Figure 4. Manage apps menu

  4. From the Manage apps page, click on the CircleCI for Jira app under User-installed apps to expand the app details and click Configure.

    Expand App Details
    Figure 5. Expand App Details

  5. Provide your CircleCI organization ID and allowed audiences.

    Your CircleCI organization ID is only needed for the initial setup. You can find it by navigating to Org  Overview in the CircleCI web app.

    This integration authenticates via OpenID Connect (OIDC). By default, the organization ID provided is used for audience validation, but this can be modified, or more can be added.
    Set the Organization ID on the app Configure page
    Figure 6. Set organization ID on the app Configure page

  1. Select Submit to save your changes.

    Set the Organization ID on the app Configure page
    Figure 7. Set organization ID on the app Configure page

  2. Now copy your Web Trigger URL for use in the next section.

    Copy the Webtrigger URL
    Figure 8. Copy the Webtrigger URL

Configure the Jira orb

The circleci/jira orb is responsible for relaying information about your build or deployment to the CircleCI Jira application.

  1. Begin by saving the Web Trigger URL from the previous section as an environment variable. This could be added as a Project Environment Variable or within a Context. We recommend naming the variable JIRA_WEBHOOK_URL.

  2. Next, import the Jira orb into your .circleci/config.yml file and implement the jira/notify command at the end of your build and deployment jobs. Detailed and up-to-date configuration examples can be found on the orb page.

View build and deploy statuses in Jira

The circleci/jira orb automatically detects the Jira ticket number from the branch name or commit message. The build or deployment status is then posted to the appropriate Jira ticket. You can view build and deployment information, natively, in the right sidebar of any Jira ticket.

Jira build status
Figure 9. Jira build status

From this sidebar menu you can click into the build or deployment information to view the full CircleCI job details.

Jira builds tab
Figure 10. Jira builds tab