Referencing issues in your development work

Enjoy the seamless integration of issues and code when you have 

Jira Software

  connected to Bitbucket Cloud, and your other development tools.

In Bitbucket Cloud, you can see and interact with issues just as you would in

Jira Software

. Edit, comment, add attachments, transition, watch, and much more.


Developers just have to reference Jira issue keys from 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,

GitHub,
GitHub Enterprise,
Fisheye 

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,
GitHub,
GitHub Enterprise,
Fisheye 

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,
GitHub,
GitHub Enterprise

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.

Build plans 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.
Deployment projects Bamboo

A deployment to an environment, such as Production or testing, is linked to an issue 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 Nov 23, 2017

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.