Get started guide for Jigit - Jira GitHub & GitLab integration for Jira On-Premise administrators.

Jigit Plugin Configuration

To start the Jigit plugin configuration you have to generate Access Tokens

How to generate Personal Access Token in Git Hub? [add links]

How to generate Personal Access Token in Git Lab? [add links]

Once Personal Access Token is ready you can move to the integration set up.

First of all, you have to add a new configuration on the Global configuration page:

  1. Move to the Jira Administration section (“gear” button in the right corner of the navigation menu).

  2. Navigate to the Manage app page and find our application Jigit Plugin Config on the right sidebar.

  3. On the Global Configuration page navigate to the Jigit Plugin Configuration tab.

  4. Click on Add and create a new configuration. After you have specified all the parameters click on Ok button to save the new configuration.

  5. Test Connection button allows you to check the connection and communication between Jira and the connected GitHub or GitLab accounts.

Below you can find a short definition of each parameter you have to specify in the modal window that appeared in front of you:

Parameter

Definition

Alias

indicate an alias for your repo which will be displayed on the commits tab page; an alias should be unique; you can't add two repositories with the same alias.

Host

enter a host of your Git server; it can be https://github.com, or https://gitlab.com, or your instance on the GitLab server (for example, https://my.own.gitlab:8443)

Access Token

authentication token you created before that allows an individual user to authenticate and access GitHub resources

Path

path key; it can be either a repository name or a repository group (GitLab) or organisation (GitHub) name; a repository name usually consists of two parts and is displayed in the query string of a browser.

For example, in the URL https://gitlab.com/gitlab-org/gitlab-ce  the name of the repo is gitlab-org/gitlab-ce and the group name is gitlab-org.

Also you have to specify content type inside a given path: repository or a group of repositories (drop-down opposite the path)

To include all repositories in a group you need to use .* mask.

Subgroups are only working with Gitlab.

Default Branch

branch of your GitHub or GitLab repository that will be used for integration with Jira, by default it is indicated master branch; Jigit indexes git commits from the default branch and then from the others

Index

a way of branch indexing:

  • all branches inside a repository;

  • selected branches;

  • branch mask helps filter and match specific branches in your GitHub or GitLab repository.

The aim is to decrease the number of API calls if this number is limited (it's actually for https://github.com, for example). If you select the "all branches" option, Jigit makes API calls to check whether there have been new git commits since the last check (even to stale branches).

Jira Projects

Jira project list where the commits and pull requests should be visible

Commit indexing window

a time period within which commits are indexed and associated with Jira issues

Commit request timeout

the maximum amount of time allowed for making a request to retrieve commit information from the connected GitHub or GitLab repository; this parameter is used when Jigit calls the git server by HTTP API, and if the timeout is exceeded during a call the add-on stops the indexing of a repository. If you see ConnectException: Connection timed out in JIRA logs, you can increase this value to overcome it.

Sleep

the duration of a pause or delay between consecutive requests made by the integration to the connected GitHub or GitLab repository

each

frequency at which the integration checks for new commits or changes in the connected GitHub or GitLab repositor

Enable smart commits

allows you to enable or disable the use of smart commits; Jigit support for smart commits for transition: if you write the commit message in the form #in-progress (important: hash, no spaces and dashes), the issue will be transitioned to the status In Progress. The smart commits work similarly to the Bitbucket Smart Commits.

Available since 3.04.01

Ignore smart commits older than

lets you to specify a time duration after which smart commits should be ignored

Add git activities as issue comments

checkbox-controller whether Git activities, such as commits, pushes, and merges, are automatically added as comments to associated Jira issues

Index pull requests

allows you to control whether pull requests from your connected GitHub or GitLab repositories are indexed and synchronized with Jira; when this parameter is enabled, the integration will actively monitor and index the pull requests in your repositories

Display repos in the development panel

the visibility of repositories in the development panel of Jira