Connecting JIRA with CircleCI

This document describes how you can connect JIRA to your CircleCI builds. With the CircleCI JIRA plugin, you can display your build statuses in JIRA.

Note: You have to be an JIRA admin to install this plugin.

Installation steps

  1. Navigate to project settings and select JIRA integration
  2. Go to the Atlassian Marketplace to get the CircleCI JIRA Plugin
  3. Install the plugin and follow the prompts to set it up.
  4. Return to the CircleCI JIRA Integration settings page and add the generated token.

Viewing build and deploy statuses in Jira

With CircleCI orbs it is possible to display your build and deploy status in Jira Cloud. To do this, you will need to:

  1. Make sure you followed the steps above to connect Jira Cloud with CircleCI.
  2. Make sure that you are using version 2.1 at the top of your .circleci/config.yml file.
  3. If you do not already have Pipelines enabled, you will need to go to Project Settings > Advanced Settings and turn it on.

  4. To get an API token for build information retrieval, go to User Settings > Tokens and create a token. Copy the token. (Note: older versions of the JIRA orb may require you to retrieve a Project API Token, which is accessible from Project Settings > API Permissions)
  5. To give the integration access to the key, go to Project Settings -> Environment Variables and add a variable named CIRCLE_TOKEN with the value being the token you just made.
  6. Add the Jira orb to your configuration and invoke it (see example below).

The example config below provides a bare config.yml illustrating the use of the Jira Orb.

version: 2.1
orbs: # adds orbs to your configuration
  jira: circleci/jira@1.0.5 # invokes the Jira orb, making its commands accessible
      - build:
            - jira/notify # Runs the Jira's "notify" commands after a build has finished its steps.
      - image: 'cimg/base:stable'
          username: mydockerhub-user
          password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
      - run: echo "hello"

Help make this document better

This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.