Git Integration for Jira Self-Managed (Data Center/Server) Documentation

Contact Support

GitHub.com

These instructions apply to instances on Free, Team, Cloud Enterprise (including EMU) plans hosted on GitHub.com.

For instructions on self-hosted GitHub Enterprise Server, please see this page.

Using Jira Cloud?  See the corresponding article.

Integrate GitHub.com with Jira Data Center/Server

Quickly learn how to connect GitHub.com git repositories via Git Integration for Jira Data Center app.

What’s on this page:


Watch the video guide by clicking here to open this video in a
new browser tab for more viewing options.

Creating a personal access token

If two-factor authentication is enabled for your GitHub account, you will need to create a PAT to access your git repositories. Enable two-factor authentication in your GitHub.com account for increased security.

While instructions from GitHub works just fine, follow this article for some specific instructions to get you started.

Using Full feature integration

This process requires an existing GitHub git repository.

We recommend using the Add new integration panel (formerly Auto-connect integration) to connect multiple repositories from your GitHub.com account.

This setup uses full feature integration offering functions and features not found on single repository connections.
 

On November 13, 2020, GitHub.com is going to stop allowing API authentication via username/password. For more information, see GitHub.com – Deprecating Password Authentication.

We strongly recommend to use personal access tokens for GitHub.com account integration.

  1. On your Jira dashboard menu, go to Git ➜ Manage repositories.

  2. Click GitHub.com on the Add new integration panel. The Add new integration wizard dialog is displayed.

  3. GitHub.com and GitHub Enterprise Cloud is selected by default. Paste the personal access token in the provided box.

    • Configuring the Advanced settings is optional. However, admins/power users may set how the project listing is displayed.

      • Custom API Path  –  this is a relative path that starts with "/". The maximum allowed length is 2000 characters or less. The integration will use the supported relative REST API path to retrieve the list of tracked repositories.
        For more examples, see article Working with Custom API Path – GitHub.com.

      • JMESPath filter  –  JMESPath is a query language for JSON used to filter API results and to limit which repositories are integrated.   The maximum allowed length is 2000 characters or less.

        For help with writing expressions, please contact support. Read about JMESPath expressions on their website.
        For some other examples, see Working with JMESPath Filter in GitHub.com.

      • Fetch refspec  –  Git refspecs contains patterns mapped as references from the remote to the local repository.
        For more information, see Git Internals — The Refspec.

        • The first two refspec options are required.

        • The rest of the options are OPTIONAL:

          • Clone and index ref notes (refs/notes) – This is a reference to refs/notes/* used for fetching.  This option is enabled by default.  This affects git notes which are not shown:

            • …when refs/notes are disabled on connecting a repository.

            • …when a new note comes when refs/notes is disabled.

          • Clone and index changes (refs/changes) – This is a reference to refs/changes/* used for fetching.  This option is turned off by default.

          • Clone and index other refs – This is a user-defined list of references used for fetching.  It is a comma-separated list with the format:

            • +refs/refname1/*:refs/refname1/*, refs/refname2/*:refs/refname2/*, ...

    While Custom API Path and JMESPath filter are mutually exclusive, you can use one, the other, both or neither.

  4. Click Connect.

  5. On the following screen, the Git Integration for Jira app will read all available repositories from your GitHub account. Click Import repositories.

    Repositories of the logged-in GitHub user can be automatically connected to Jira Data Center. Repositories that are added or removed from GitHub will be likewise connected or disconnected from Jira Data Center.

  6. After the import process, the Settings screen is displayed.

    • On the Integration Settings, setting the Require User PAT option to ON, will require users to provide PAT specific for branch and merge requests (via the developer panel on the Jira issue page).

      For more information on this feature, see Integration Settings: Require User PAT.

    • Set Smart Commits and Repository Browser to enable/disable these features.

    • Set Project Permissions according to your organization’s project association rules. For detailed information, see Associating project permissions.

  7. Click Finish to complete this setup.

The GitHub.com repositories are now connected to Jira Data Center.

There will be a slight delay in adding 2FA-enabled repositories compared to others. These will show in the git configuration list eventually.

Single repository (Manual integration)

This section is for users who are using SSH connections or those who wanted to only connect a single specific repository.

This process requires an existing GitHub git repository. Look for the GitHub repository URL on the repository project page.

Choose between SSH or HTTPS. Use this information to connect the GitHub git repository to your Jira Data Center via Git Integration for Jira app:

  1. On your Jira dashboard menu, go to Git ➜ Manage repositories.

  2. Click Connect to Git Repository (or click the Git icon on the Add new integration panel) to open the Connect Wizard.

  3. Paste the URL from GitHub in the provided box.

  4. Continue to the next step by following the screen instructions.

  5. Click Finish to complete this process.

The repository is now connected to Jira Data Center.

Setting up GitHub permissions

We recommend using a "service user" in GitHub (example: Git-Integration-for-Jira) to be used to integrate GitHub with the Git Integration for Jira app. This dedicated "service user" will allow the GitHub administrator to set permissions so the app clones only the desired repositories.

Assign GitHub permissions for team members or collaborators to allow which resources are accessible for service users. This feature is only available in a GitHub Organization.

Default repository permission

  1. Login to your GitHub.com account.

  2. Go to Profile ➜ Settings.

  3. On your sidebar, click Organizations.

  4. Click Settings for the selected organization.

  5. On your sidebar, click Member Privileges. The following screen is displayed.

  6. Under the Base permissions, click on the dropdown button.

    Choose the base permission level for organization members. The base repository permission only applies to organization members and not to outside collaborators. If the base permission is set to None, organization members will need to be given access to repositories using the Teams or Collaborators methods (see below).

  7. Save the changes.

For more information, see Access Permissions on GitHub ».

Teams and collaborators

To give a member additional access, they must be added to a team or make them collaborators on individual repos.

Set default repository permission for the current team:

  1. Open an organization team. (Your org ➜ Teams ➜ scroll down to the bottom then click the desired team.)

  2. Click the Repositories tab.

  3. Set ReadWrite or Admin repository access as desired.

Assign members to a team on your GitHub repository:

  1. Create a team in your GitHub Organization.

  2. Invite a member to add it into the team.  An email invitation is sent to that GitHub service user.

    The service user is then added to the team if the invitation has been accepted.

  3. Click the service user to manage permissions for this member to:

    • set the desired Role for this member.
    • convert this member to outside collaborator.
    • give this member access to organization repositories.
    • remove this member from the team.
  4. Click Manage access to manage repository access for this member.

Organization permissions
While users have configured PAT for repository access, users in a GitHub Organization must at least have Read permissions. This allows them to view commits and smart commits, and browse repositories (if enabled) of connected GitHub Organization repositories inside Jira.

GitHub Organization
For collaborators and commit authors, set these users to have Write permissions. This will allow them to view commits and smart commits, browse repositories and also enables them to create branches and pull requests to specified GitHub git repositories via developer panel of a Jira issue.

The user PAT for “Require User PAT” setting should have Write permission. Otherwise, the user will not be able to use it for branch or pull request creation/deletion.


For more information on organization teams, see GitHub: Organizing Members into Teams ».

For more information on inviting collaborators, see Inviting Collaborators to a Personal/Organization Repository ».

Setting up GitHub web links

The Git Integration for Jira app automatically configures web linking for GitHub git repositories.

For single repository connections, web link setup is optional. However, git links will become available in Git Commits tab when configured.

For more information on this feature, see Documentation: Web linking.

Viewing git commits in Jira Data Center

  1. Perform a git commit by adding the Jira issue key in the commit message. This will associate the commit to the mentioned Jira issue.

  2. Open the Jira issue.

  3. Scroll down to the Activity panel then click the Git Commits tab.

  4. Click View Full Commit to view the code diff.

For more information about this feature, see Documentation: Viewing commit code diffs.

Require User PAT settings for user access

For teams looking to maintain user attribution, Jira administrators can place a requirement where individual Jira users must provide personal access tokens to perform certain actions. This includes actions such as creating a branch or pull request in Jira using their git service account – rather than the integration account.

For more information, see Require personal access tokens for user access.

If the Require User PAT option is enabled in the Integration Feature Settings and a user PAT isn’t configured yet for the selected repository via Repository Browser, a text label about setting up your PAT is displayed on the create branch and create pull/merge request dialogs.

Click this text label to open the Setup PAT dialog and paste your personal access token in the provided box. Click Update.

Setup PAT dialog

Updating this dialog with a blank entry will remove the configured PAT for the current integration.

The Setup PAT dialog is also accessible via Repository Browser (dashboard menu Git ➜ Repository browser) ➜ Click the  (edit icon)  icon under Pers. Access column.

Working with branches and pull requests

This process requires a GitHub git repository and a PAT with repo scopes.

For GitHub Organization, the user must have the Write permissions and the repo PAT scopes.

Default branch

Most git integrations allow changing of the default branch of the repository/project other than "master". This change is reflected in the Repository Settings of the Git Integration for Jira app on the next reindex. Full integration supports this function where Git Integration for Jira app gets the default branch from almost all integrations and apply this setting at repository level.

Main branch for repositories within an integration can only be changed on the git server.

Creating branches

On your Jira Data Center, open a Jira issue. On the Jira developer panel under Git Integration, click Create branch. The following dialog is displayed.

Pointers:

  1. Select a Repository from the list.

    If there are several repositories with the same name, the listed GitHub repositories will have their names attached with a GitHub organization name. For example, BigBrassBand/second-webhook-test-repo.

  2. Use the search box to look for the specific repository that will be used.

  3. Choose a Base branch.

  4. Enter a Branch name or leave it as is (recommended).

The Git Integration for Jira Data Center app gets the default branch from almost all integrations. However, the exception is with Gerrit which always has ‘master’ as its default branch.

The newly-created branch is now listed in the developer panel under Branches. Perform a commit to the newly-created branch to be ready for merge.

Creating pull requests

The pull request feature works the same as merge request. On your Jira Data Center, open the Jira issue where your previously created a branch. On the developer panel under Git Integration, click Create pull request. The following dialog is displayed.

Pointers:

  1. Select a Repository from the list.

    If there are several repositories with the same name, the listed GitHub repositories will have their names attached with a GitHub organization name. For example, BigBrassBand/second-webhook-test-repo.

  2. Use the search box to look for the specific repository that will be used.

  3. Choose the newly-created branch as the Source branch.

  4. Set master as the Target branch.

  5. Enter a descriptive Title or leave it as is (recommended).

Preview allows you to see the comparison view of the current changes in the selected Source branch vs Target branch (usually master).

The pull request is listed on the developer panel of the Jira issue page.

The pull request is also ready for approval by the reviewers in your GitHub web portal.

More Integration Guides

GitHub.com (this page)

GitHub Enterprise Server (Git Integration for Jira Data Center/Server)

GitLab.com (Git Integration for Jira Data Center/Server)

GitLab CE/EE (Git Integration for Jira Data Center/Server)

Azure DevOps | Visual Studio Team Services (VSTS) (Git Integration for Data Center/Jira Server)

Azure DevOps Server | Team Foundation Services (TFS) (Git Integration for Jira Data Center/Server)

AWS CodeCommit (Git Integration for Jira Data Center/Server)

Gerrit (Git Integration for Jira Data Center/Server)

Windows Network | Server Share (Git Integration for Jira Data Center/Server)

Tracked Folders (Git Integration for Jira Data Center/Server)

Bitbucket Server (Git Integration for Jira Data Center/Server)

Bonobo (Git Integration for Jira Data Center/Server)

Integration basics (Git Integration for Jira Data Center/Server)

Have feedback about this article? Did we miss something? Let us know!
On this page