Linking GitHub accounts

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

You can link your GitHub and GitHub Enterprise accounts and their repositories to Jira, and see the development information from pull requests displayed in your issues.

Supported versions

Here’s a list of supported versions:

Jira versionGitHubGitHub Enterprise
8.14+Current13.0+
7.0+Current11.10.290+

Prerequisite: Create the OAuth access token in GitHub

First you need to create the OAuth access token in GitHub to give Jira permissions to access it.

You need to be logged in as a user with administrative rights to the account in GitHub.

  1. Choose Edit Your Profile

  2. Select Applications

  3. Choose Register new application

  4. Enter Jira DVCS for the Application Name

  5. Enter the Jira Software URL for both the URL and Callback URL fields. Press Register Application

    Make sure you enter the Jira Software Base URL (for example, https://example.atlassian.net) for both the Homepage URL and Authorization callback URL fields. Don't use the dashboard URL (https://example.atlassian.net/secure/Dashboard.jspa). 

  6. Keep your browser open to your DVCS and go to the next step.

Link your GitHub account

To add a GitHub account in Jira:

  1. Go to Administration > DVCS accounts.

  2. In Host, select GitHub or GitHub Enterprise, depending on what you’re using.

  3. Enter the Team or User account name.

  4. Copy the GitHub’s OAuth Key and OAuth Secret, and enter them as Client ID and Client Secret.
  5. Leave the default auto link and smart commits (recommended) as is or change them.
  6. Click Add

    If you get redirected to a blank page, see DVCS connection to GitHub produces blank page.

What’s next?

Here’s what happens after adding your account:

  • Syncing repositories: Your account appears on the DVCS page and Jira starts syncing its repositories, if you decided to link them automatically. For details, see Integrating dev tools using DVCS.

  • Matching issues: If your commits and pull requests include issue keys, Jira will try to find them and add the relevant information to your issues. For details, see Referencing issues in your development work.

  • Displaying dev info: If referenced correctly, the dev information will be added to your issues to give everyone involved more context. For details, see Viewing the dev info for an issue.

  • Workflow triggers: One of the benefits of integrating your development tools is adding workflow triggers that, for example, lets you change the issue status after you create a new branch. For details, see Configuring workflow triggers.

Last modified on Mar 23, 2021

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.