Getting Started

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. You can also install separate plugins for GitHub - Github Integration for Jira Software. For GitLab - Gitlab Integration for Jira Software. For Bitbucket - Git Integration for Bitbucket and Jira.

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

The configure page allows you to connect to your GitHub, GitLab, Gitea, AWS CodeCommit, Azure DevOps, GitHub Organizations, Beanstalk, GitHub Enterprise, GitLab Enterprise, and Bitbucket repositories. Select the repository and authenticate your account. Connection with the Gitea, AWS CodeCommit, GitHub Organizations, Beanstalk, GitHub Enterprise, and GitLab Enterprise is more difficult so see special pages with manuals.

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.

Checking and clearing Logs

Click the “Action” icon nearby the enabled repository. If you select “Logs” the information list about logs will be opened.

But if you select “Clear logs” nothing will be shown but logs will be cleared. It could be checked by viewing the “Logs”.

Using Repo Explorer

Click the “Repo Explorer” icon nearby enabled repository.

You could see the information about all commits, branches and pull requests of selected repository.

Select project permissions

In the configuration settings for each connected repository was added the ability to define which Jira projects the repository is connected with.

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 RING-1, showing all the commits with RING-1 in the commit comment.

Creating a new Branch

You can create new branches just right in Jira Git. Click the “New Branch” icon nearby enabled repository.

The repository name is already chosen. Select the “Source branch” from the drop-down list and select the “Issue” from the drop-down list.

Click the “Create branch” button. If everything is correct, the new branch will be created.

Creating a new Pull Request

You can create new pull requests just right in Jira Git too. Click the “New Pull Request” icon nearby enabled repository.

The repository name is already chosen. Select the “Source branch” from the drop-down. Select the “Target branch” and the “Issue”.

Click the “Create pull request” button. If everything is correct, the new pull request will be created.

Creating Release Tags

Tags can be created in the GitHub, GitLab or Bitbucket account by clicking the “Draft a new release” button in the repository in GitHub, the “New tag” button in Gitlab and the “Create tag” button in Bitbucket.

Important to know that tags will shown in your ticket only if you’ll tie tag with ticket while creating commands.

You could check tags in the ticket while clicking the “Open Jita Git” and scrolling down to the “Tags”.

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

Comparing Commits

After opening board with tickets you can select the ticket. Click on it and look at the “Activity”. Click the “Git” button and then click the “Compare commits” button.

There is possible to compare two different commits by selecting the “Repository” name, first and second commits from drop-down lists.

After clicking the “Compare” button you will see the information about comparison.

Creating Private Repository

In Jira Git you can connect to any git repo by clicking on the same named button in the “Connect to Repository” drop-down list.

Then you need to enter valid data into a form. The repository url is available on the “Repository” pages in GitHub, GitLab and Bitbucket accounts. You can authorize by three ways: using login and password, generating ssh key and uploading ssh private key.

For example in GitHub you can find URL by two ways:

After entering all data into a form click on the “Add” button. Enable private repo and then create a command for the ticket in GitHub, GitLab or Bitbucket. After that you need to reindex private repo and the commit will matched.