Jira Cloud

About the integration

The Jira integration allows Sleuth to use Jira Cloud as a deployment issue tracker. When you deploy, Sleuth will automatically connect your Jira issues to the deploys, so you can always find the source of your changes later. Direct links to related Jira projects are provided in the deploy cards, allowing you to quickly see the Jira issues that affect your deploys.
Integration with Jira Cloud is made at the Sleuth organization level. More than one issue tracker can be integrated with an organization. Although you can have multiple projects within an organization, each project can only configured to use a single issue tracker. Bitbucket, due to its own integration with Jira Cloud, can be used as one of those since Bitbucket can automatically connect to your Jira issues as long as both of those Atlassian products are both logged in with the same account. Bitbucket can also serve as a code deployment source change.
Once Jira Cloud is configured as the issue tracker, every time the Jira issue key is included in a deploy's commit message, Sleuth will automatically link that deploy with the corresponding issue in Jira Cloud.
Check out the Sleuth for Jira integration in the Atlassian Marketplace.

Setting up the integration

To set up the Sleuth Jira Cloud integration:
  1. 1.
    Click Integrations in the left sidebar, then click Issue Trackers.
  2. 2.
    In the Jira Cloud tile, click enable.
  3. 3.
    Enter the API Token, Email, and fully qualified URL of your Jira Cloud instance into the corresponding fields, then press Save. To quickly access your Jira Cloud instance to obtain an API token, click generate.

Custom HTTP headers

If you using Jira on-premise behind Cloudflare access or similar, Sleuth might need to include some HTTP headers in order to reach your instance. In order to set Sleuth to send any custom HTTP headers when making requests:
  1. 1.
    In the Jira dialog, click on the Advanced setting
  2. 2.
    Enter comma separated list of custom headers you want Sleuth to include
The message Jira enabled is displayed in the tile.
Successful integration!

Configuring the integration

After setting up the Jira Cloud integration, you must designate which Sleuth project to use as the default issue tracker. If you are configuring the integration immediately after setting it up, you can go directly to step #2 below.

To set the default issue tracker:

  1. 1.
    Click on Integrations in the left sidebar, then on Issue Trackers.
  2. 2.
    Click on the Jira Cloud Set default issue tracker dropdown (see screenshot above).
  3. 3.
    All projects in the organization are displayed. Select which project you'd like to set Jira Cloud as the default issue tracker for.
You can also change the default issue tracker at any time.

To change the default issue tracker:

  1. 1.
    Click on Project Settings in the left sidebar, then select Details.
  2. 2.
    Select a new default issue tracker. The integration must be connected at the organization level before it can be selected.
  3. 3.
    Press Save.

Removing the integration

If you wish to disconnect the Jira Cloud integration for the organization:

  1. 1.
    Click on Integrations in the left sidebar, then on Issue Trackers.
  2. 2.
    Click disable. The message Jira disabled is displayed in the Jira Cloud integration card once the integration is dissolved.
The Jira Cloud integration is disconnected and no longer available to any projects within that organization. Any projects that used the Jira Cloud integration will need a new default issue tracker selected.

To set a new default issue tracker:

  1. 1.
    Click on Project Settings in the left sidebar, then select Details.
  2. 2.
    Select a new default issue tracker. The integration must be connected via the organization before it's displayed here.
  3. 3.
    Press Save.
The Jira Cloud integration is disconnected and no longer available to any projects within that organization. You will need to select a new default issue tracker for any projects that used the Jira Cloud integration. Simply follow the instructions in the section above: To set a new default issue tracker.
Copy link
On this page
About the integration
Setting up the integration
Custom HTTP headers
Configuring the integration
To set the default issue tracker:
To change the default issue tracker:
Removing the integration