Connect your code with your project management in Jira. A separate Jira subscription is required. With two of your most important tools connected, you'll spend less time managing projects and more time working on them. This integration is an open source project, built and maintained by GitHub.

• Installation and setup
  • Requirements
  • Installation
  • Connecting your GitHub Organization
  • Authorization
• Using the integration
  • Development information in Jira
  • Take action using Smart Commits
  • Link issues in GitHub
• Migrating from the DVCS connector
• Need help?
• Contributing
• License

This app officially supports GitHub.com and Jira Cloud. Support for GitHub Enterprise and/or Jira server may be considered in the future.

1. Sign into your Jira Cloud account
2. Open the left sidebar by clicking on Personal Settings, if the left side bar is not already open. From the left sidebar in Jira, select Jira Settings -> Add-ons -> Find new add-ons. (If you're using an older version of Jira, you won't have a left sidebar. Instead, click the Gear Icon in the top-right corner and select Settings. From there, select Manage add-ons from the left sidebar.)
3. Search for GitHub for Jira and Click Install
4. Click the Get Started button to connect your GitHub account.

Next you will need to connect your GitHub organization to Jira, see the following steps.

1. Go to https://github.com/marketplace/jira-software-github
2. Complete the (free) order for your GitHub Organization
3. On the installation setting screen, choose which repositories you want to use with the Jira Integration and press Save:
4. Once installation completes, you will be redirected to https://jira.github.com/github/setup. Enter the site name for your Jira instance here and click Continue
5. Once on the Atlassian add-on page, click Install.
6. Once the add-on is installed, click the Get Started button.

As part of the installation flow you should be directed to install the Jira app on GitHub to your organization. You can also manage existing connections or add additional organizations any time within the Manage Add-ons section of your Jira settings:

If you originally gave the app access to "All repositories" and you've created a new repository on GitHub after installing the GitHub integration for Jira, your new repository will automatically work with the integration. If you installed the app on a subset of repositories, the app will need to manually edit your repository selection by:

1. Sign into your Jira Cloud account
2. From the left sidebar in Jira, select Jira Settings -> Add-ons -> Manage Add-ons -> GitHub -> Configure
3. Select Configure next to the relevant organization

By granting the app access, you are providing the following authorizations to your GitHub and Jira accounts:

Read, Write, and Admin for Development Information (branches, commits, and pull requests)

To access the development information in Jira...

Smart commits are documented on the Atlassian site and allow to you comment on Jira issue in commit messages, branches, and pull requests. For example: [JRA-123] fix typo will be sent through to Jira and appear in the Development Information section of the Jira issue with the key JRA-123

example

If an issue body contains a Jira issue key, then the integration will try to expand the link. For example: [JRA-123] will be expanded into a link JRA-123 fix typo and linked over to Jira. Currently only keys surrounded by [ ] work.

Existing users of Jira's built-in DVCS connector that meet the requirements should migrate to this integration. If you've not yet been prompted to do so, you can manually kick off the migration by:

1. Sign into your Jira Cloud account
2. From the left sidebar in Jira, select Jira Settings -> Applications -> DVCS accounts.
3. Follow the prompt to upgrade your GitHub connection

Please fill out GitHub's Support form and your request will be routed to the right team at GitHub.

Want to help improve the integration between GitHub and Jira? Check out the contributing docs to get involved.

The project is available as open source under the terms of the MIT License.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.