GitHub Enterprise integration with Jira: a step-by-step tutorial

Teamwork is an important element of the modern workplace and two of the best tools to enhance collaboration and cooperation are GitHub and Jira. While GitHub allows writing code with fellow colleagues and controlling versions, Jira is great for advanced time management due to multiple features it provides. So wouldn’t it be great if we could get the best of both tools at the same time and bring development and project management together? There are a lot of apps out there that will help you integrate Jira and GitHub, however, the fact that you can use third-party apps doesn’t mean that you should. We have prepared a step-by-step guide that will help you connect these two important tools without a single line of code or third-party apps. See all information about your branches, pull requests and commits in Jira and make working on projects more efficient.

Note: The following steps have been tested for GitHub Enterprise Cloud and Atlassian Jira Software v8.2.0, but we expect them to work with all versions of Jira Software 8.*.*.

Requirements: system admin rights for GitHub and Jira

Step 1 (GitHub)

1. In order to connect your GitHub and Jira, you need to have an OAuth access token for the account that has administrative rights for the repository. Thus you will get a “Client ID” and a “Client Secret”.

The GitHub OAuth app page for “Jira Server” with the Client ID and Client Secret highlighted

2. In order to get a “Client ID” and a “Client Secret”, go to the GitHub site and click on the avatar in the top right-hand corner → select “Settings” in the drop-down menu and click “Developer settings”.

The GitHub account menu open, with “Settings” highlighted

3. Select “OAuth Apps”

The GitHub Developer settings on OAuth Apps, with “Register a new application” highlighted

and click “Register new application

The empty “Register a new OAuth application” form with application name, homepage URL, description and authorization callback URL

You can choose any “Application name”, but the best practice is to use “Jira Server”, since we have a connection to a Jira server, or the name of the instance if it has a name.

4. Fill out the details. Homepage URL = Authorization callback URL = Base URL of the Jira instance. You can find it in your Jira system information here:

Jira system information with the Base URL highlighted, the value needed for the GitHub application
The same OAuth form filled in with the application name “Jira Server” and the Jira base URL as homepage and callback URL

Click the Application tab and you will see the “Client ID” and “Client Secret”:

The GitHub OAuth app page for “Jira Server” with the Client ID and Client Secret highlighted

IMPORTANT:
Open Jira and GitHub as two tabs in the same browser window

Step 2 (Jira)

Requirements: admin rights

1. First, we need to link the Jira project. Click “Project Settings“→ “Development tools” (bottom left)

Jira project settings with “Development tools” highlighted in the left menu

2. Click “Connect” and select GitHub Enterprise

The Development tools page with the Connect menu open and “GitHub Enterprise” highlighted

3. Enter a Team or User Account = Name of the GitHub account, which is generally related to the repository (in our case, it’s “AntonActonic”)

A GitHub profile page with the account menu open, showing the team or user account name needed in Jira

4. Host URL = “https://github.com” in this case, as we want to connect to GitHub

5. Copy your Client ID and Client Secret from GitHub (see instructions on GitHub “OAuth” above) into the dialogue and click “Add”

The Jira “Add New Account” dialog for DVCS with host GitHub Enterprise, the account name, host URL, client ID and client secret

VERY IMPORTANT:
You should be logged into GitHub in another tab in the same window.

The GitHub authorization screen for the Jira Server application, with the Grant and Authorize buttons highlighted

6. Click “Continue” → “Grant” → “Authorize”

Jira showing “Linking account – operation in progress” while the new DVCS account is connected

The account you have connected and all of its repositories will appear on the ‘DVCS Accounts‘ page and the synchronization will start automatically.

The DVCS accounts page listing the connected GitHub account with its two synchronised repositories

Synchronization can take up to one hour.  In the case of errors, resync individual repositories.

In the project settings, it should look like this:

The project's Development tools page listing the connected GitHub Enterprise account and its capabilities

And that’s it! When you have completed all the steps, you will have access to your GitHub repository directly from inside Jira.

We hope this tutorial was useful to you. If you have any questions, please contact us.


Check out our other articles:

Let’s stay in touch!

Follow us on LinkedIn, Facebook and Twitter to get regular updates, tips and special offers.

Want
to know more?

Contact us to talk to our experts and have all your questions answered.

Request
free offer

How useful was this post?

Click on a star to rate it!

Average rating 5 / 5. Vote count: 1

No votes so far! Be the first to rate this post.