Git-Jira Integration

Introduction

 

The Jira Git Integration is designed to show a developer's Git commits within Jira for more efficient project management and tracking. It is designed to allow a project manager to quickly and easily see what work is done in and by whom on any Jira issue.  The app searches your Git repository and indexes commit comments to Jira issues. This app supports connections to GitHub, GitLab and Bitbucket repositories.  

You can find this app on the Atlassian Marketplace here.

Getting Started - Overview

 

Getting started is easy.  Install our app, set up your repository and have your team start making commits referencing the Jira issues they are working from.    

App Install via Atlassian Marketplace

 

Visit the Jira Git Integration Atlassian Marketplace page.  Select the “Get it now” button to begin the installation.  Follow the prompts to complete the installation.  

Setup Your Repository

 

Connecting to your Git repository in Jira is simple.  After you have installed the Jira Git Integration app you can navigate to our repository configuration page using the following steps:

  1. Choose -> System

  2. Advanced -> Jira git integration

 
 
 
 
 

Fill in the Jira config setting to set up the correct work of the commands that the commit messages will include.

Email - a valid user, who will  send  the command through the commit messages

API token - a unique token created in the Manage Account settings in Jira

The configure page allows you to connect to your GitHub, GitLab and Bitbucket repository.  Select the repository and authenticate your account.  

Once a connection has been made you can view the connection details, refresh, or disconnect at any time.  All repositories belonging to your account will appear as shown below.  By default, they are turned off.   

The connection can be turned on or off by the toggle button as shown turned on below.  

The Action menu allows you to reindex or unindex a repository.   

For your convenience, you can use logs of indexation for your commands. Click on the Logs icon. A list of indexing commands will be displayed. They are sent using the GitHub, GitLab, and Bitbucket repository.  

 
Linking Git commits to your Jira Issue

 

Linking your Git commits to a Jira issue is super easy.  When a developers commits their code all they need to do is reference the issue they are working on.  

Commit Comment Example (For a Jira project with an issue labeled SB-3)

 

Example: Added login feature as described in SB-3

 
Viewing Commits in Jira

 

Git commits are available for a project and for a specific issue.  

 

Viewing Project Commits

 

To view a Project Commit navigate to the project our repository configuration page by the following steps:

 

Choose -> Project -> Jira Git Integration  

All commits related to this project are shown here:

Viewing Issue Commits

To view, an Issue Commit navigate to the Jira issue and click on the Git tab located as shown below.

 

Clicking on Git will display all the commits created for a specific issue.  This example shows the bottom of the page for Jira issue SB-3, showing all the commits with SB-3 in the commit comment.

 
Git commands

 

The commands allow you to comment, assign, and/or transition Jira issues and add a work log to them via Gitlab, Github, or Bitbucket commits.

 

Comment command

 

The #comment command allows for adding the comment to a Jira issue. You must add the command to the commit message in the following format:

<Issuekey> #comment <your comment text>

 

Example, QWER -1 #comment Please give more detail information

 

Time command

 

The #time command allows for adding the time value into the work log to the Jira Issue. You must add the command to the commit message in the following format:

 

<Issuekey>#time[Some amount in Jira time syntax]<

 

Your work log comment text, the time should be written in the following format: Xw:Yd:Zh

 

Example, QWER-1 #time 1w:1d:2h Total work logged

 

Transition command

The #transition command allows for the changing workflow state of the issue. If the transition state is not valid, or the user does not have access to make this change, then the transition will not work. You must add the command to the commit message in the following format:

<Issuekey> #<transition-name> <Your comment text>

Example, QWER-1 #transition In Progress
 

Assign command

The #assign command allows assigning of the particular issue to a specified Jira user. You must add the command to the commit message in the following format:

<Issuekey> #<assign> <Jira username>

Example, QWER-1 #assign Admin