Reference issues in your development work

Enjoy the seamless integration of issues and code when you have Jira Software connected to Bitbucket Cloud, GitHub, GitLab, and your other development tools. Learn how to link repositories to a project.

In Bitbucket Cloud, you can see and interact with issues similar to the way you would in Jira Software. Edit, comment, add attachments, transition, watch, and much more.

Check your Safari settings

If you have Prevent cross-site tracking enabled in Safari, you won't be able to open Jira issues in the same tab or window. To view the issue, open it in a different tab or window.

Before you begin

Make sure you have:

For GitHub, GitLab, and Git for Jira integration, perform the following steps:

  1. On the Code page, click Settings on the top left meatballs menu.

  2. On the Apps page, find or manage apps for integrations with your Jira project.

  3. Refer to each marketplace app documentation for the instructions on how to install and allow connection flows between your project and the third-party app.

Ensure that you have appropriate permissions to associate the code repositories with your project.

How to reference Jira issues in developer tools

Developers just have to reference Jira issue keys in commits, branches, pull requests, etc, as described in the table below.

In all cases, the issue key must use to the default Jira key format – that is, two or more uppercase letters ([A-Z][A-Z]+), followed by a hyphen and the issue number. For example, ABC-123.

 

Tool

Instructions

Commits

Bitbucket, GitLab, GitHub, GitHub Enterprise, Fisheye

Other service providers or SCM tools

Include the issue key in the commit message.

For example, a commit message like this "TIS-1 Initial commit" will automatically transition the TIS-1 issue from 'To Do' to 'In Progress'.

Branches

Bitbucket, GitLab, GitHub, GitHub Enterprise, Fisheye

Other service providers or SCM tools

Include the issue key in the branch name when you create the branch.

If you create the branch from the Development panel in a Jira issue, the issue key is added automatically.

For example, if you name your branch "TIS-2_feature", the TIS-2 issue in Jira will automatically transition from 'To Do' to 'In Progress'. (Note that Git doesn't allow spaces in branch names.)

Pull requests

Bitbucket, GitLab, GitHub,
GitHub Enterprise

Other service providers or SCM tools

Do at least one of the following:

  • Include a commit in the pull request that has the issue key in the commit message. Note, the commit cannot be a merge commit.

  • Include the issue key in the pull request title.

  • Ensure that the source branch name includes the issue key.

If you create the pull request from the Branches dialog of the Development panel in a Jira issue, the issue key is added automatically.

For example, if you create a pull request that has "TIS-3" in the title, the TIS-3 issue will automatically transition from 'In Progress' to 'In Review'. If you reopen, decline, or merge the pull request, it will also transition the TIS-3 issue accordingly.

Reviews

Crucible

Include the issue key in the review title when you create the review.

For example, if you name your review "TIS-4 New story" and start the review, the TIS-4 issue will automatically transition from 'In Progress' to 'In Review'. If you reject, abandon, or close the review, it will also transition the TIS-4 issue accordingly.

Builds

Bamboo

Bitbucket Pipelines

Other service providers, SCM tools, or CI/CD Pipelines

For Bamboo, a build is automatically linked to an issue if one of the build's commits includes the issue key in its commit message. The issue key must be included in the commit to activate this feature.

For Pipelines, simply include the issue key in the branch name.

Deployment

Bamboo

Bitbucket Pipelines

Other service providers, SCM tools, or CI/CD Pipelines

A deployment to an environment, such as production or testing, is linked if a commit associated with the deploy contains the issue key in its commit message. The issue key must be included in the commit to activate this feature.

Last modified on Oct 20, 2020
Cached at 5:34 AM on Oct 27, 2020 |

Additional Help

Ask the Community