This tutorial builds upon previous guides:

In this tutorial, we will cover two main topics:

A. Integrating Jira with a GitHub Repository

B. Syncing Jira Workflow with GitHub Activity

A. Integrating Jira with a GitHub Repository

  1. Navigate to Apps in the Jira navigation bar and select Explore more apps. In the search field, type GitHub for Jira and proceed with the installation by clicking Get App → Get it now.

    Screenshot 2024-08-11 at 19.04.21.png

  2. Once the installation is successful, click the Get started button to integrate Jira with your GitHub repository. Click Continue on the initial Connect GitHub to Jira page.

    Screenshot 2024-08-11 at 16.39.59.png

  3. Next, select GitHub Cloud if your repository is hosted on GitHub. Then, click the Next button.

    Screenshot 2024-08-11 at 16.42.05.png

  4. If this is your first time integrating Jira with GitHub, you will be prompted to log in and authorize the connection. Once authorized, select the repositories you want to integrate with Jira. You can choose multiple repositories by clicking Select organization / another organization.

    Screenshot 2024-08-11 at 16.49.03.png

  5. The organization can either be from a personal GitHub account or a GitHub Organization (only accessible by administrators).

    Screenshot 2024-08-11 at 16.50.15.png

  6. After selecting the organization, choose the specific repositories you want to integrate. In this example, we'll select only one repository, test-jira. Then, click Install.

    Screenshot 2024-08-11 at 16.51.55.png

  7. If the installation is successful, the integration page will look like this:

    Screenshot 2024-08-11 at 16.52.52.png

  8. On the right side of the Jira Issue details, there will be a Development section used for tracking branches, commits, and pull requests from GitHub.

    Screenshot 2024-08-11 at 16.54.29.png

  9. To ensure branches and commits are reflected in Jira, Jira enforces the following rules:

    1. Branch names must follow Jira’s naming convention, which is derived from the issue number + the issue title. For example, for the Subtask issue KAN-3 Design Task Creation UI, the branch name should be KAN-3-design-task-creation-ui or follow the template provided by Jira.

      Screenshot 2024-08-11 at 16.57.57.png

    2. To ensure commits are tracked in Jira, the commit message must include the issue number. For example, for issue KAN-3, the commit message should include KAN-3.

      Screenshot 2024-08-11 at 16.59.25.png