Getting Started with Git Integration Plugin for Jira

Overview

The Jira Git Plugin is an add-on for your existing Jira server/cloud that combines the data in your Git repository with the projects and issues in Jira.

With Git Integration Plugin for Jira, start working with Git in the familiar Jira interface.

Overview Git add-on

Quick Installation

Using Atlassian's marketplace system, a Jira administrator can install the Git Integration Plugin for Jira add-on without ever leaving the web browser.

Easily install the add-on via Atlassian Universal Plugin Manager:

  • Menu Jira Administration Add-ons

    Install Git Integration Plugin for Jira via Jira Administration > Add-ons.

  • Search git then buy or trial the Git add-on

    Enter git or BigBrassBand on the search bar 2. Buy the add-on or start the free trial for 30 days 3.

  • Browse user-installed add-ons

    After generating license code and several prompts, the Git add-on will appear in the Manage Add-ons list.

Login to your Atlassian account, when prompted, to acquire the license based on your selected license mode.

No need to do git server command lines to copy or configure XML files.

For manual installation or via Atlassian Marketplace, see Git Integration Plugin for Jira add-on - Installation  open in new tab.

Configuring SSH Keys

Configure SSH keys via Administation > Manage Add-ons > Git Integration Plugin for Jira > SSH Keys.

  • Adding SSH keys

    Add a new SSH key by clicking the Add SSH key button.

  • Input SSH private key

    Name the SSH key. Import a private key file or paste private key from clipboard. Enter passphrase, if required.

  • Set SSH key association

    Mark the required repository or repositories to associate the SSH key via Actions > Associations.

For a more detailed information about SSH keys, configuring and generating SSH keys for git hosting systems, and associating SSH keys to selected repositories, see Git Integration Plugin for Jira add-on - Working with SSH Keys open in new tab.

Working with Git Repositories

Manage git repositories linked to your Jira server via Administration > Manage Add-ons > Git Integration Plugin for Jira > Git Repositories.  Use the Actions icon to edit, delete or reindex selected repositories.

  • Git Repositories page Connect

    To connect a repository with the Git add-on, click Connect to Git Repository on the Manage Git Repositories page.

  • Connect to Git Repo wizard repo location

    Enter required Repository Location based on the Location Type examples. Click Next.

  • Git Repositories page Edit Reindex

    The newly added repository will appear on the list. Edit or Reindex repositories via the Actions command.

Go to the Advanced setup of the Connecting to Git Repository wizard if you want more control on connecting your git repository to Jira.

All Git server repositories are supported including:

  • Git repositories running on the same server as Jira
  • Git repositories running on a different server in an internal network
  • All hosted Git repositories including GitHub, BitBucket, Beanstalk, and CloudForge.
  • Any Git server that is accessible via SSH, HTTP, HTTPS, git protocol, local file path, or network share is supported.

An unlimited number of repositories are supported.

If your Git host configuration requires web linking, see Git Integration for Jira add-on - Web Linking open in new tab.

Linking Git Commits to Jira Issue

This is where Git Integration for Jira add-on shines the most -- code view and diff inside Jira!  Open a Jira issue then go to the Git Commits tab.  In this tab, you will see commits, files changed, links to external repository, commit author and more.

The git commit will get associated with the Jira issue if the start of the commit message includes the exact issue ID.  Git Integration for Jira will automatically index new commits and associate the referenced issue.

Refer to the following examples:

  • Example Git commit message

    Example Git commit message: "GIT-913 - Plugin version...". In this case, "GIT-913" is the issue key linking the commit message to the Jira issue.

  • Example Git commit

    The "GIT-36 added log message" comment – assumes that you have configured a Jira project with the key 'GIT' and someone has created the issue #36 within this project.

Git administrator »

If you want to enforce the commit with a hook, please install this Git commit hook script. Commit-msg Hook open in new tab .

Web Linking

The web linking feature adds links to your git hosting provider directly into the Git Commits tab.

helpful tip
Configure web linking options while adding/editing repository settings so that commits can include links to the git host pages.

 

Configure Web Linking for GitHub/GitLab

For more information, see Documentation: Web Linking open in new tab .

Smart Commits

Smart commits allows your team to perform actions on Jira issues from a single commit.  Users can enter the issue key and the desired action such as time tracking or closing an issue.

Smart commit example

The smart commit processing is active by default and can be enabled/disabled via the repository configuration.

Example:

TEST-100 #time 4h 30m Fixed null issues #comment Fixed code #resolve

Logs specified #time of 4 hours and 30 minutes then adds a worklog message "Fixed null issues" to the issue, TEST-100; adds the #comment 'Fixed code' and resolves the issue.

Code Review and Viewing Commits

Users must have 'View Development Tools' permission in order to view commit information on the issue page.

Viewing commit code diffs in Jira:

  • Repository Browser view a file

    View a file on the Repository Browser (Git > View All Repositories). Open a project. Select a file.

  • Repository Browser compare

    On the Compare results screen of the Repository Browser, click a file on the Summary page.

  • Project Git commits tab

    Go to Administration > Projects. Select a project. Select the Overview tab > ADD-ONS icon > Git Commits. Click a file on a commit or click View full commit.

  • Git Roll Up tab

    Open an issue. Select the Git Roll Up tab then click a file under Files.

  • Issue Git commits tab

    Open an issue. Select the Git Commits tab then click a file or click View full commit.

Git links and git tags (2.8.0+) are now available and can be accessed on the code review developer panel.

Git tags Jira panel

Code view expander is now available when pulling up code diff dialogs in Git Commits and Git Roll Up tabs.

Diff code view

Each click on the expanders # lines hidden label expands up to 20 lines of code on that section.

Commit Email Notifications

The user will get notifications when watching an issue or repository.  The user will receive repository commit notifications if that repository is being watched by the user.  If the user watches an issue, any commit related to the issue will be sent to that user as notifications.

  • Start watching this issue]

    Issue commit notifications will be e-mailed to users who chose to Start watching this issue.

  • Repository Browser watch repository]

    Repository commit notifications will be e-mailed to users who chose to watch that repository.

Repository Browser and Comparing Commit Branches

The Repository Browser allows users to view git repositories of configured projects via the Git menu on the Jira dashboard.

Repository Browser

Compare commits from the two branches of the current repository using the Compare tab.

Repository Browser compare

JQL Searching

The Git Integration Plugin for Jira add-on has added JQL operators and fields to query Jira using JQL and git context via the Jira search.

Example: gitBranch in (Version-5.2, Version-5.3)

Returns the search result for all issues referenced by a git commit that has branch Version-5.2 and branch Version-5.3.

Get new product notifications and feature updates from BigBrassBand LLC.