Jigit - GitHub, GitLab, Azure DevOps integration for Jira
Jigit - GitHub, GitLab, Azure DevOps integration for Jira
Breadcrumbs

Jigit - Cloud Configuration

Jigit Cloud connects GitHub and Gerrit to Jira, surfacing pull requests, branches, and code reviews directly on Jira issues. This guide explains how to install and configure both integrations on Jira Cloud.

Admin access required. You must be a Jira Administrator or Site Administrator to configure Jigit. Access the admin page via Jira Administration > Apps > Jigit.

Installing Jigit

  1. Go to the Jigit listing on the Atlassian Marketplace.

  2. Click Try it free.

  3. Select your Jira Cloud site.

  4. Click Review, then Start free trial.

Admin page overview

image-20260624-022510.png

The Jigit admin page has four tabs:

Tab

Purpose

Gerrit

Add and manage Gerrit Code Review server connections. Linked changes appear in the Gerrit tab in the Jira issue Activity section.

Integrations

Add and manage GitHub integrations (organisation or single repository). Pull requests and branches appear in the Jigit Development panel on Jira issues.

Settings

Global settings including Jira project scope, branch naming patterns, and user authentication strategy.

Migration

Import a configuration export from Jigit Data Center. See the Jigit - Migrating from Data Center to Cloud.

Configuring Gerrit

Each Gerrit configuration connects Jigit to one Gerrit server. You can add multiple configurations for different servers or environments. Jigit searches Gerrit for issue keys each time a Jira issue is opened - changes are fetched on demand rather than pre-indexed.

Adding a Gerrit configuration

image-20260321-032751.png

  1. Navigate to Jira Administration > Apps > Jigit > Gerrit.

  2. Click Add configuration.

  3. Complete the configuration form (see field reference below).

  4. Click Test connection to confirm Jigit can reach the Gerrit server using the credentials provided.

  5. Click Create.

image-20260321-033520.png

Gerrit configuration fields

Field

Required

Description

Configuration name

Yes

A label to identify this configuration in the admin UI, for example Production Gerrit.

Gerrit URL

Yes

The base URL of your Gerrit instance, for example https://gerrit.example.com. Must start with http:// or https://. Do not include a path or query string.

Username

No

The Gerrit account username for HTTP Basic authentication. Leave blank for anonymous access to a public Gerrit instance.

Password

No

The HTTP password for the Gerrit account. Generate this in Gerrit via Settings > HTTP Credentials. This is not the same as your Gerrit login password. Required if a username is provided.

Included Jira spaces

No

Limits this configuration to specific Jira project keys. If empty, all projects are included. Cannot overlap with Excluded Jira projects.

Excluded Jira spaces

No

Prevents this configuration from running for specific Jira project keys. Cannot overlap with Included Jira projects.

Search for issue in

No

Selects where Jigit looks for the Jira issue key within a Gerrit change. Choose one or more: Commit (commit message), Topic (topic field - uses Topic Pattern), Branch (target branch name), Comment (change comments). Defaults to commit messages if nothing is selected.

Topic pattern

No

A regex applied to the Gerrit topic field when Topic is selected above. Use {ISSUE_KEY} as a placeholder for the Jira issue key. Default: ^.*{ISSUE_KEY}.*. Example: ^feature/{ISSUE_KEY}$ matches topics like feature/PROJ-123.

Load batch size

No

Maximum number of Gerrit changes fetched per request when displaying linked reviews on a Jira issue.

Viewing Gerrit code reviews in Jira

  1. Open a Jira issue.

  2. Scroll to the Activity section.

  3. Select the Gerrit tab.

  4. Linked changes are listed per configuration, showing the change subject, status (Open, Merged, Abandoned), and reviewer votes.

image-20260331-182141.png

If the Gerrit tab does not appear, check that at least one Gerrit configuration is active and that the Jira project is within scope (not in the configuration's Excluded Jira projects list).

Configuring GitHub (Integrations tab)

GitHub integrations connect Jigit to a GitHub organisation or repository. Jigit indexes branches and pull requests every 5 minutes and links them to Jira issues using the issue key found in the PR title, branch name, or PR body.

Authentication types

Auth type

How it works

Best for

Personal Access Token (PAT)

A GitHub PAT is stored securely and used for all API calls on behalf of the token owner.

Simple setup. Suitable for smaller teams or when a GitHub App is not available.

GitHub App

Jigit uses the App private key to generate short-lived installation tokens automatically. Tokens are cached and refreshed without manual intervention.

Recommended for organisations. Higher API rate limits, granular permissions, and no dependency on an individual user account.

Integration types

Type

Path format

What Jigit indexes

Organisation

my-org

All (or selected) repositories in the organisation account. New repositories can be picked up automatically.

Single repository

my-org/my-repo

One specific repository only.

Adding a GitHub integration with a Personal Access Token

Step 1: Create a GitHub Personal Access Token

  1. In GitHub, go to Settings > Developer settings > Personal access tokens.

  2. Generate a new token (classic or fine-grained).

  3. For a classic PAT, grant: repo (or public_repo for public repositories only) and read:org (required for Organisation integrations).

  4. For a fine-grained PAT, grant Read access to: Contents, Pull requests, Metadata.

  5. Copy the token.

Step 2: Add the integration in Jigit

  1. Navigate to Jira Administration > Apps > Jigit > Integrations.

  2. Click Add integration.

  3. Set Authentication type to Personal Access Token.

  4. Complete the configuration fields (see field reference below).

  5. Paste the PAT into the Personal access token field.

  6. Click Test connection.

  7. Click Create.

image-20260624-025040.png

Adding a GitHub integration with a GitHub App

Step 1: Create and install a GitHub App

  1. In GitHub, go to your organisation or personal Settings > Developer settings > GitHub Apps.

  2. Click New GitHub App.

  3. Configure the app:

    • Name: any descriptive name, for example Jigit Integration

    • Homepage URL: your Jira site URL

    • Webhook: disabled unless enabling webhook support

    • Repository permissions: Contents (Read-only), Metadata (Read-only), Pull requests (Read-only)

  4. Click Create GitHub App.

  5. Note the App ID shown on the app settings page.

  6. Under Private keys, click Generate a private key. Save the downloaded .pem file.

  7. Click Install App and install it on your organisation or selected repositories.

Step 2: Add the integration in Jigit

  1. Navigate to Jira Administration > Apps > Jigit > Integrations.

  2. Click Add integration.

  3. Set Authentication type to GitHub App.

  4. Complete the configuration fields (see field reference below).

  5. Enter the App ID from the GitHub App settings page.

  6. Paste the full contents of the .pem file into the Private key field.

  7. Click Test connection.

  8. Click Create.

image-20260624-025416.png

GitHub App installation tokens are short-lived and refreshed automatically by Jigit. You do not need to rotate them manually.

Integration field reference

Field

Required

Description

Integration name

Yes

A label to identify this integration in the admin UI, for example My Org - GitHub.

Integration type

Yes

Organisation indexes an entire org. Single repository indexes one specific repository.

Base URL

Yes

The root URL of the GitHub instance. For GitHub Cloud this is always https://github.com. Must use https:// with no path or query string.

Path

Yes

For Organisation / User: the org or username (e.g. my-org). For Single repository: the full owner/repo path (e.g. my-org/my-repo).

Authentication type

Yes

Personal Access Token or GitHub App.

Personal access token

PAT auth only

The GitHub PAT. Stored securely and displayed masked after saving.

App ID

GitHub App only

The numeric App ID from the GitHub App settings page.

Private key

GitHub App only

The full contents of the .pem private key file for the GitHub App.

Included Jira spaces

No

Limits this integration to specific Jira project keys. Cannot overlap with Excluded Jira projects.

Excluded Jira spaces

No

Prevents this integration from linking PRs to specific Jira project keys. Cannot overlap with Included Jira projects.

Managing repositories

For an Organisation / User integration with Index all repositories disabled, select which repositories to index from the integration detail view.

  1. From the integration drop down menu, click Repositories.

  2. The Repositories section lists all repositories discovered from the organisation.

  3. Toggle the switch next to each repository to enable or disable indexing.

  4. Use the search box to filter by repository name.

Up to 2,000 repositories can be enabled per Jira site across all integrations. Indexing begins automatically within 5 minutes of enabling a repository.

Integration statuses

Status

Meaning

Action

Active

Integration is running normally. Indexing runs every 5 minutes.

None required.

Disabled

Integration has been manually disabled.

Toggle the enabled switch to reactivate.

Rate limited

GitHub API rate limit was exceeded. Jigit resumes automatically when the limit resets.

Wait for the reset, or switch to a GitHub App for higher rate limits.

Failed

An error occurred (invalid credentials, repository not found, etc.).

Update credentials or the path, then save. Jigit retries on the next scheduler run.

Unsupported

Migrated from Data Center with a provider not yet available in Cloud (GitLab, Azure DevOps). Configuration is preserved.

For Azure DevOps, use Azure DevOps for Jira. For GitLab, no action needed.

Delete Existing Data from Integration

This action removes all indexed pull requests, branches, and selected repositories associated with the integration. The integration configuration itself is retained.

The deletion is performed as a background process and may take some time to complete, depending on the amount of indexed data.

This action cannot be undone. Once deleted, the indexed data must be re-synchronized if it is needed again.

Viewing Git data in Jira

  1. Open a Jira issue.

  2. Find the Jigit Development panel in the right-hand sidebar.

  3. The panel lists linked pull requests and branches, including their title, state (open / merged / closed), and repository name.

Settings

Global settings apply across all Gerrit configurations and GitHub integrations.

Setting

Description

Included Jira spaces

Global include list. If set, Jigit is only active for these Jira project keys. Takes precedence over per-integration include settings.

Ignored Jira spaces

Global ignore list. Jigit does not display data for these spaces however indexation still occurs

Branch naming patterns

Patterns for generating branch names from Jira issues. Placeholders: {issue-key}, {issue-type}, {issue-summary} (slugified). Default: {issue-type}/{issue-key}_{issue-summary}.

Link branch action

When enabled, a Link branch action appears on Jira issues so users can create or link a branch using the naming pattern above.

Link change request action

When enabled, a Link change request action appears on Jira issues for creating or linking a Gerrit change.

User authentication strategy

Controls whether users must connect a personal GitHub account. No (default): no personal connection required. Required: users must connect before Jigit features are shown. Required for action: users can view data without connecting but must connect to perform actions.

Allowed Git systems

Restricts which Git provider types can be added as integrations. Defaults to GitHub only.

Migration secret

Passphrase used to encrypt credentials in a Data Center export. Change this before exporting from DC if you want a custom passphrase. See the Jigit - Migrating from Data Center to Cloud.

User Git Connections

Individual Jira users can connect their own GitHub accounts to Jigit. Data is then displayed based on the user permissions, rather than the integration authentication. This is only mandatory when the User authentication strategy in Settings is set to Required or Required for action.

Users access this page via Profile menu > Jigit Git Connections, or from Apps > Jigit Git Connections in the Jira sidebar.

Method

Description

OAuth

Connect via GitHub OAuth. No manual token handling required. Available when the integration is configured to support OAuth.

Personal Access Token

Paste a GitHub PAT generated from your GitHub account settings. The token is stored securely.

Personal user credentials are not migrated from Data Center. After a migration, users must reconnect their accounts via this page.

Updated: