Git Integration for Jira Cloud Documentation

Contact support
GitKraken Status  

Developer – FAQ

This page contains solutions targeted for developers.

Use the FAQ below to find answers to common questions.  Feel free to contact our support team if you don’t see what you’re looking for.

How do Git commits get associated with a Jira issue?

How do I ensure people are following our organization’s process for source code?

What will happen to Jira issue associations with commits if the Jira issue is moved to a new project?

Can the plugin be configured to handle or scan multiple keys for one project?  How is this supposed to work?

 


 

How do Git commits get associated with a Jira issue?

On every Git commit, make sure the message includes the exact issue ID at the beginning of the text. The Git Integration for Jira Cloud app will automatically index new commits and associate the referenced issue.

To create a link between your Git commit and a Jira issue, developers must include the issue key into the commit comment.

Example git commit message:

PROJ-913 - Plugin version change from 2.6.7 to 2.6.8“; where PROJ-913 is the issue key that links the commit message to the Jira issue.

 

How do I ensure people are following our organization’s process for source code?

Open the project summary in your browser and click on the Git Commits tab.

All changes that developers have submitted will be listed in reverse chronologically order.  From this view, you can audit all of the changes that developers have recently submitted.

 

What will happen to commit associations if a Jira issue is moved to a new Jira project?

For GIJ Cloud users, moving Jira issues to a different project is not recommended, especially for repositories with extensive git commit histories. This is because associated git commits from the old project do not automatically transfer to the new project due to the different project key.

The Git Integration for Jira Cloud app allows users to manually associate git commits to a Jira issue via the Repository browser.

To manually associate git commits to a Jira issue in Jira Cloud:

  1. Go to Jira dashboard menu Apps ➜ Git Integration: Repository browser.
  2. Click a repository to work on. The list defaults to the Compare view.
  3. Click on the Commits tab.
  4. On the right of the list item, click on the edit icon or the Link commit label to manage Jira issue association for the selected git commit.
  5. Add, remove or change one or more Jira issue keys to assign the selected commit.
  6. Please note that manually linking git commits in this manner can only be done one at a time.
The Git Integration for Jira Cloud app also supports multiple issue keys in a commit message.

For Jira administrators planning to migrate from Jira Server/Data Center to Jira Cloud, please read this first – Export project from Jira Server to Jira Cloud.

When transitioning from Jira self-hosted to Jira Cloud, maintaining the same project name will retain all git commit associations after the migration.

 

Can the plugin be configured to handle or scan multiple keys for one project?  How is this supposed to work?

Yes – the Git Integration for Jira Cloud app supports multiple Jira issue keys in a multiple-line commit message.

For more information, see Smart Commits ».

Have feedback about this article? Did we miss something? Let us know!
On this page