JIRA Git Documentation

Owned by OC2 LLC
Last updated: Jul 31, 2017
2 min read

Introduction

The JIRA Git Integration addon is a tool designed to show a developers 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 addon searches your Git repository and indexes commit comments to JIRA issues.   This addon supports connections to GitHub, GitLab and Bitbucket repositories.   


Getting Started - Overview

Getting started is easy.  Install our addon, setup your repository and have your team start making commits referencing the JIRA issues they are working from.    


Addon Install via Atlassian Marketplace

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


Setup Your Repository

Connecting to your Git repository in JIRA is simple.  After you have installed the JIRA Git Integration addon you can navigate to our repository configuration page by the following steps:

  1. Choose -> System

  2. Advanced -> JIRA git integration




This 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 or disconnect at any time.  All repositories belonging to your account are shown below.  By default they are turned off as shown below.   


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



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.