« Table of Contents

Setting Up Repositories

Setup repositories and manage them in the Git add-on configuration in Jira.

 

Go to cog Administration  > Add-ons  >  Git Integration Plugin for Jira  > Git Repositories.

helpful tip
If using Jira 7, go to Administration  > Add-ons. Select Applications on the page tab. Under Git Integration Plugin for Jira on the sidebar, select Git Repositories.

The Git configuration page can also be accessed via the Dashboard Git menu > Manage repositories.

In this page, a git host/server can be connected to Jira via the Connect to Git Repository button.

Jira Server Only  Administrators can perform the Bulk Change action to import git repositories configuration into Jira using a TSV file or export git repositories configuration to a TSV file.  For more information, see Bulk Change.

Jira Server Only  The Enable All and Disable All actions will enable or disable all connected repositories in the Git configuration list.

The Reindex All action will reindex all repositories/servers in the Git configuration list.

The Git configuration list displays the connected repositories/servers, location, enabled/disabled state, display name, last index and status.

To the right of the Status column are actions that can be performed for the selected connected repository/server.

warning
When setting up repositories with the Git add-on, you need to have the necessary access permissions on the private key on the Git server to proceed.
helpful tip
The Git Integration for Jira add-on supports v3 and v4 of the GitLab API (in both Jira Cloud and Jira Server).
note
For cases when git repositories are hosted at Windows servers (Windows Server network drive) — while it is using the Windows server networking, the network credentials accessing the git repository must be the same as the user running Jira.
warning
When using Windows network shares for the repository origin, it is recommended to allocate repositories’ paths shorter than 256 characters.
For example: \\WS129\custom-repo\project-z\
Otherwise, the provided URL will not be recognized as valid.
fyi
For Jira hosted on Windows:
When using Active Directory accounts for repository access, changing the password of the AD account running Jira can cause repository authentication issues.
The solution for this is to restart Jira to regain access to repositories.
fyi
As of v2.8.3 of the Git add-on, the REST API for add, update, and delete repository is implemented.  The documentation for this feature is available at Git add-on: Hook and API Reference - Repository REST API open in new tab.

Using the Add Repository Wizard

Click Connect to Git Repository.  The Add Git Repository wizard is displayed.

Enter required repository location.

Click Next. The wizard will automatically detect the entered repository location type.

fyi
Detection of Remote Origin Setting
The detection works for most repositories. If a repository root points to a valid git repository, the repository origin is detected automatically.  When a repository has no origin, the user has to specify it manually.
note
Do note that the repository wizard clones the remote repository by default.  It does not clone local repositories. For local repositories, it sets root to local path and disables fetches.
Starting v2.6.7 of the Git add-on, the default identities are not used and the repository is created without the additional key upload.
helpful tip
If the Git repository file system is somehow available to the Jira server, you can save the clone step and save the disk space on a Jira server by pointing the Jira server straight at it.

Settings

In the Settings screen, enable or disable the Git Viewer feature for this repository as required.

Enable or disable the Smart Commits setting for this repository as required.

Enter available projects as required in the Associate Project Permissions field or check the Associate to All projects checkbox to associate all projects.

note
The View Development Tools project permission must be granted to Users > Group > Project Roles.

Click Next.

 

HTTPS Authentication

If the entered git host requires http credentials, the following screen appears:

Provide Username and Password in the respective fields then click Next to continue.

note
The HTTP authorization errors indicate that the credentials provided are not valid.

Configure the required SSH private key by navigating to the private key file or pasting the private key text into the pastebox.

note
For establishing safety connection with SSH, upload a Public Key to the SSH server and set the Private Key to the SSH client.
Take note that the SSH server is the Git server and the SSH client is the Jira server.
helpful tip
When adding a new repo that requires an SSH key, you can now pick an existing associated key in the Existing key list.

Click Next to proceed.

 

Passphrase Input

Enter the Passphrase, if required. Click Next to continue.

note
The passphrase screen only appears if the user has added an SSH key that requires a passphrase.
fyi
The Git add-on will try first to use the keys provided by the user before using the keys from the home directory.

After the above requirements are fulfilled, the wizard will:

  • create a local copy of the git repository; and
  • index the git repository to build change history.

Click Finish to close the wizard.  The newly added repository appears on the git repositories list of the add-on.

Adding a Repository via Advanced Setup Jira Server Only

warning
As of v2.6.12, the Git add-on supports repositories that do not have a branch named "master".

Use the Advanced setup if you have set up the Git repository ahead of time outside of the Jira Git add-on.  Configure repositories via Advanced setup in order to manage advanced options.

Open the Connect to Git Repository wizard then click the Advanced Setup label.

The following advanced setup screen is displayed.

Enter the required information.

Utilize the following options for adding new git repositories:

Repository Settings
Display Name  –  This is the name that will appear in the Git add-on repositories list. (Required)
Repository Root  –  This is the local path to the repository on the server where your Jira service is running.  This will point the Git add-on to a clone of the repository hosted locally with Jira. (Required)
Enable Fetches
Git repository hosted on remote server
In this mode, fetches are enabled using any external source. The reindex background service will initiate the fetch then add the new commits to the plugin index.
Git repository hosted on same server as Jira
Fetches are enabled when the repository is hosted locally. In this mode, no fetches are made. The reindex service runs in the background and process every new commit found.
Repository Origin
This is the URL to the hosted git service used on the project.
For example, you might host your repository on GitHub, Beanstalk or your own server.
fyi
The repository origin may not be hosted on the same server as Jira.

The detection works for most repositories. If a repository root points to a valid git repository, the repository origin is detected automatically. When a repository has no origin, the user has to specify it manually.
Revision Indexing
This option turns on the memory cache which is used when list of commits are displayed.  Select if revision indexing will index and link to any mentioned issue keys in the revision history or not.
Revision Cache Size
This is the size of the memory cache.  If some particular commit is not cached, it is fetched from the Lucene index which involves some disk activity.
Enter the number of revisions to keep the cache in memory.  The default value is 10000.  Higher values can affect the performance of the retrieved revisions from Git.
Main Branch
Specified branch will intend to organize the git commit tab.  A commit will not be shown in other branches if it is a part of the main branch.  By default, "master" will be used if a main branch is not specified.
When editing or updating repository settings, this field will allow a user to select from a list of available branches to assign as master for the selected repository configuration.
Use basic http authentication
Most git hosts provide http access to git repositories.  Enter required credentials to configure basic http authentication to remote git repositories.
Tags
Show all tags  –  This will display all the tags for the specific issue.
Show tags matching the pattern  –  This will display tags on issue pages that match the specified regular expression pattern.
release2[.](7|8)[.][0-9]+
This example is a filtering regexp for a range of releases from 2.7.x to 2.8.x.  The sidebar will display git tags for release versions 2.7.0 to 2.8.x in decending order.
Repository Browser
Enables or disables the Git Viewer feature for this repository. The default setting for this option is Enabled.  Users must have the View Development Tools project permission in order to use this feature.  Consult your Jira System Administrator on permissions.  For more information, see section, The Repository Browser.
Project Permissions Jira Server
Associate Project Permissions  –  One or more projects must be mapped to this repository to make Git Commits tabs available in the Issue screens of the associated projects.
fyi
This field requires at least one existing project if the Repository Browser for this repository is enabled.
Associate with all projects  –  Enable this option to associate this repository to all projects.  Disable this option if you want to use existing mapped projects from the Associate Project Permissions field.  The default setting is enabled (checked).
Click Advanced to enable/disable limitation of commits shown in Git Commits issue tab, Git Commits page and all across the Git Integration for Jira add-on by project association.
This only applies when project associations are set.  If the Associate with all projects option is enabled, this feature is ignored.
If this option is enabled for a git repository and there are project associations set, the git data is not shown from that repository in any project except those from the project associations list.
Unless the issue is from a project association list, some data are not shown such as:
  • Commits, branches and tags in the Issue sidebar.
  • Commits in Git Commits tab.
  • Commits in Git Commits page.
  • Commits and branches in Git Roll Up tab.
  • Commits in Project/Issue pages.
  • Commits in Compare pages. User read/view permission restriction also applies.
note
This option defaults to true when setting new project associations.
Limit git data - upgrade and installation defaults:
Condition Repository Result

Upgrade to new add-on version

Has several repositories with project associations

Defaults to OFF because there is no sudden change in behavior

Upgrade to new add-on version

Adds a new repository and set project associations

Defaults to ON because it is a new repository

Installs add-on for the first time

Adds a new repository and set project associations

Defaults to ON because it is a new repository
Source Code Diff Viewing
When enabled, this setting allows Jira users with the View Development Tools and correct Jira/Git Integration for Jira add-on permissions to view the commit and file diffs inside Jira.
Smart Commits
This setting is enabled by default (as of v2.6.3 of the Git add-on).  See section, Smart Commits
Commit Notification Emails
Send notifications  –  Enables or disables commit notification emails for this repository.
Max. commit age in minutes  –  Set the desired value in minutes, as to when commit notifications will be sent.  Commit notifications will be e-mailed if the age of the commit is less than or equal to this value.
Weblinking
The Weblinking configuration is optional.  For more information about this option, see section, Weblinking.

Click Add to save the settings.  The newly added repository appears on the git repositories list of the add-on.

Repositories created via the Advanced setup will perform an initial reindex.

Adding a Repository Hosted on Windows Servers or Windows Network Share

Add a new network share or Windows server hosted repository via the Connect to Git Repository wizard.

The wizard will continue without errors if the following conditions are met:

  • The network credentials accessing the git repository must be the same as the user running Jira.
  • The network path is not longer than 255 characters.
  • The user under which Jira is running should at least have read access to network path.

In the Git configuration page, edit the repository via Actions > Edit repository.

Under Repository Settings, set Enable Fetches option to Git repository hosted on the same server as Jira.

Verify network folder share name by opening the shared folder properties.

Make sure that the user has read access permissions to the network path.

Setup Repository Root Not Located in Jira Home Directory

There are three possible ways to setup a repository root that is not located in the Jira home directory:

  • Clone the repository outside of Jira then connect to it via Connect to Git Repository  >  Advanced Setup.
  • Clone the repository with the standard Connect to Git Repository Wizard into the Jira home directory.  Soon afterwards, move the cloned repository and update the settings on the repository.
  • You could symlink the {$Jira_HOME}/data/git-plugin directory to a different volume.  The standard Connect to Git Repository Wizard will still write there, but the data will reside on the different volume.  But be aware, that Git add-on treats anything in the Git-Plugin folder as a clone that it owns.

Adding Tracked Folders Jira Server Only

helpful tip
For a more detailed information about this integration, see Integration Guide: Adding Tracked Folders  new tab/window .

Introduced in v2.9.0 of the Git add-on, this feature scans a locally accessible path for cloned Git repositories and automatically imports those Git repository references into Jira.  A repository group called FOLDER is added into the Git add-on repository settings.

warning
The Add tracked folder feature requires that Jira and the git servers be on the same filesystem.  Make sure that the user that Jira is running with has access permissions to the path with the git repositories.

 

For this feature, a local path to the git repository residing on the same server as Jira is required.  For example, /home/ec2-user/repositories/*.

Use this path via Git Repositories configuration page > Connect to Git Repository dropdown > Add tracked folder.

In the above example repository root, /home/ec2-user/repositories/*, all repositories under this mask (/home/ec2-user/repositores/<repo1>, /home/ec2-user/repositores/<repo2>) will be handled as one entry in the Git Repositories configuration page.  For other features, these are treated as separate repositories.

fyi
The Add tracked folder wizard scans the local path one folder level deep.
Jira Administrators

It is possible to track all repositories hosted on a GitLab server from inside a Jira server.  Setup NFS server on the GitLab computer and mount GitLab repositories folder as a remote NFS folder on Jira server.  Configure NFS permissions to allow Jira to access GitLab folders by using either of the two possible solutions:

Solution 1.

The 'all_squash' option must not be used in the NFS server 'etc/exports' file for GitLab folders.  The NFS client should have the 'git' group with the same GID as the 'git' group on the NFS server.  The Jira user on the NFS client should be added to the group 'git'.

Example of '/etc/exports' line:
/var/opt/gitlab/git-data/repositories/testrepo xx.xx.xx.xx/24(ro,root_squash,async)

Solution 2.

Use the 'all_squash,async,anonuid=$uid,anongid=$gid' option on NFS server, where $uid and $gid are user ID and group ID for 'git' user and 'git' group respectively (or another user/group which you are using to access GitLab repositories on GitLab server).

Example of '/etc/exports' line:
/var/opt/gitlab/git-data/repositories/testrepo xx.xx.xx.xx/24(ro,all_squash,async,anonuid=497,anongid=497)
In both cases either 'ro' or 'rw' options may be used on NFS server.

Connecting to GitLab.com via Git Integration for Jira

Connect to GitLab.com git repositories via the Auto-connect integration panel GitLab icon.

GitLab v10+ stopped accepting username/password credentials for API access and will only recognize Personal Access Tokens (PAT) and OAuth authentications. Service users are strongly advised to switch from using username/password for GitLab.com to using Personal Access Tokens.

fyi
Webhooks will be automatically registered for each GitHub repository connected to Jira Cloud to instantly index your commits.  For this to work, the connecting GitHub user must be the Organization Owner or have repository ADMIN rights.
Webhooks will be deleted when GitHub integration is disconnected from Git Integration for Jira Cloud.
note
For newer GitLab authentication, in order to access a Git repository over HTTP, use the username as the username and the PAT for the password.
note
Admin/Power Users:
To pass the private access token (for example: XpigzF1JxMnAZ7mn9qgN) to an API call with GitLab.com:
curl --header "Private-Token: XpigzF1JxMnAZ7mn9qgN" https://gitlab.com/api/v4/projects?membership=true

Connecting to a GitLab Server

Introduced in v2.9.4 of the Git add-on, this feature scans a remote GitLab server and automatically imports those Git repository references into Jira.  A repository group called GITLAB is added into the Git add-on repository settings.  This feature can import more than a hundred repositories from a GitLab server and can track added or deleted repositories upon reindex.

In order for GitLab to display correct repository clone links to users, it needs to know the URL under which it is reached by the users. For example, http://gitlab.example.com.

GitLab v10+ stopped accepting username/password credentials for API access and will only recognize Personal Access Tokens (PAT) and OAuth authentications.  Service users are strongly advised to switch from using username/password to using Personal Access Tokens for newer versions of GitLab Server (CE/EE).

For GitLab Server service users, they won't see the issue until they upgrade their GitLab Servers to version 10 and higher.  Git Integration for Jira add-on offers pre-v10 GitLab Server service users as a Legacy connection option.

note
Currently the Git add-on scans only the repositories visible to the user which is used for scanning.  The repositories which are publicly visible (shared for all members or visible to the member with the admin rights) will not be scanned.  This will be supported in a future release.
helpful tip
BigBrassBand recommends a dedicated service user for this integration which has access permissions to the GitLab git repositories.
fyi
The Git Integration for Jira add-on supports v3 and v4 of the GitLab API (in both Jira Cloud and Jira Server).

Connecting to Jira Server for GitLab Server v10/Legacy:

warning
In order for GitLab to display correct repository clone linkes to your users, it needs to know the URL under which it is reach by your users (example: http://gitlab.yourorg.com).
For more information, see this article.

Connect repositories from a GitLab server (Legacy, pre-v10.2)

To connect repositories from a GitLab server (Legacy, pre-v10.2) to Jira:

  1. On your Jira Dashboard menu, click Git then Manage git repositories.
  2. On the Auto-connect integration panel, click GitLab.
  3. The Connect to GitLab wizard is displayed.
  4. Select the External service from the dropdown list.  For this guide, choose GitLab Server (CE/EE) Legacy.
  5. Enter the Host URL of the GitLab server.  Enter the username.  Enter the personal access token as the password.
  6. The Advanced option is only available for GitLab Servers.  Click Advanced to expand the option to enter the query string parameters.  This setting is used with integration to retrieve list of tracked repositories.  Set a filter that will only load some cloned repositories which can be viewed via Actions > Show tracked repositories in the Manage git repositories configuration screen.
  7. On the Repositories Found screen, the wizard will display git repositories of the git server that it finds.
  8. Click Import repositories.
  9. The wizard automatically adds the detected repositories to Jira.
  10. On the Permissions dialog, set Repository Browser and Project Association permissions, if required.  Click Next.
  11. Click Finish.

To connect git repositories from a GitLab server (v10.2 and newer):

  1. On your Jira Dashboard menu, click Git then Manage git repositories.
  2. On the Auto-connect integration panel, click GitLab.
  3. The Connect to GitLab wizard is displayed.
  4. Select the External service from the dropdown list.  For this guide, choose GitLab Server (CE/EE).
  5. Enter the Host URL of the GitLab server.  Enter the username and password credentials for server authentication.

  6. The Advanced option is only available for GitLab Servers.  Click Advanced to expand the option to enter the query string parameters.  This setting is used with integration to retrieve list of tracked repositories.  Set a filter that will only load some cloned repositories which can be viewed via Actions > Show tracked repositories in the Manage git repositories configuration screen.
  7. On the Repositories Found screen, the wizard will display git repositories of the git server that it finds.
  8. Click Import repositories.
  9. The wizard automatically adds the detected repositories to Jira.
  10. On the Permissions dialog, set Repository Browser and Project Association permissions, if required.  Click Next.
  11. Click Finish.

The GitLab server is added to the repositories list as a connected server and is automatically reindexed.

Manage a Connected GitLab Server

On the Git Repositories settings page, click  cog Actions  > Edit connected server to modify tracked repositories settings.

Reset Index

On the Git Repositories settings page, click  cog Actions  > Reset index.

This action will reset the indexes of the repositories for the selected connected server.

Manage Tracked Repositories

On the Git Repositories settings page, click  cog Actions  > Show tracked repositories.

This action will open the Tracked Folder dialog showing the tracked repositories of the connected server.

Jira Server Only Just like in the Git repositories configuration list, a tracked repository can be enabled/disabled by toggling the Enabled box of the selected repository.

note
The Repository Browser will not display the repository if it is disabled in the Git Repositories configuration. The commits and code diffs in the Issue > Git Commits, Git Roll Up and Project tabs will also be unavailable due to this.

Reindexing a Connected GitLab Server

On the Git Repositories settings page, click   Actions  > Reindex connected server.

This action will perform a reindex of the selected tracked folder.

fyi
If a new repository/project is manually added via the GitLab server, the Git add-on will automatically detect the new repository on the next reindex and add it into the existing tracked repositories of the connected GitLab server in Jira.
note
If a repository/project is manually deleted via the GitLab server, the Git add-on will automatically remove the repository setting from the tracked repositories on the next reindex of the connected GitLab server in Jira.

Removing a Connected GitLab Server

On the Git Repositories settings page, click  cog Actions  > Delete tracked folder to remove the tracked folder configuration from Jira.

A confirmation dialog will be displayed:

  1. Leave the checkbox unchecked to just remove the tracked repositories setting from the repository configuration list. (The cloned repositories for this connected server will still remain in the local system for later use); or
  2. Tick the checkbox to permanently delete the tracked repositories of the connected server and its files from the local system.

Connecting to AWS CodeCommit Jira Cloud Jira Server

AWS CodeCommit is a git host service by Amazon Web Services to store and manage source code, related files and private Git repositories in the cloud.  This service works like a Git-based repository providing similar functions to that of a git host.

helpful tip
You can use the AWS CLI or the AWS CodeCommit console to track and manage your repositories.

For more information on AWS CodeCommit configuration and deployment, see AWS CodeCommit User Guide open in new tab.

Required Permissions  Important

note
Before performing an AWS CodeCommit integration, make sure to configure the recommended permissions.

We recommend that the recommended AWS IAM policies (as seen on the Connect wizard) are configured beforehand based on what features that will be used: basic features or all features. For detailed information, see AWS CodeCommit Integration Guide: Required Permissions.

Auto-Connect

To connect your AWS CodeCommit git repositories to Jira Cloud/Server via Git Integration for Jira add-on, open the integration wizard:

  1. On the Jira dashboard menu, click Git .
  2. Select Manage Git Repositories.
  3. On the Auto-connect integration panel, click on the AWS CodeCommit icon.
  4. On the following screen, select the Region where the CodeCommit repositories reside then enter credentials for Access key ID and Secret access key.
  5. Click Continue.
  6. Click Import repositories.
  7. The Git Integration for Jira add-on supports tracked folders for AWS CodeCommit git repositories. The connected git host is scanned for existing repository folders.  The found repositories can then be added to the Git Repositories configuration.
  8. On the Settings screen, click Finish to complete this process.

The Git Integration for Jira add-on automatically configures web links for AWS CodeCommit integration in Jira Cloud/Server.

For detailed step-by-step procedure on AWS CodeCommit integration, see AWS CodeCommit Jira Cloud integration or AWS CodeCommit Jira Server integration

Manually Connect via HTTP/HTTPS

Connect a single AWS CodeCommit repository manually to Jira via HTTP/HTTPS connection.

  1. Use the host HTTP/HTTPS URL of your AWS CodeCommit repository.  For example, http://git-codecommit.us-east-1.amazonaws.com/v1/repos/test-repo and paste it on the Connect to Git Repository screen.
  2. On the Authentication screen, enter the Access Key ID as the username then the Secret Access Key as the password.
  3. Click Connect.
  4. On the Settings dialog, set Smart Commits, Repository Browser and Project Association permissions, if required.  Click Next.
  5. Click Finish.

Manually Connect via SSH

Connect a single AWS CodeCommit repository manually to Jira via SSH connection.

SSH connections are handled automatically if the PUBLIC KEY was added in the AWS IAM console and the associated PRIVATE KEY was added/uploaded on the Jira side (Git Integration for Jira > SSH Keys > Add SSH Key).

If authentication issues are encountered during connecting an AWS repository to Jira, modify the original URL by inserting the SSH Key ID as the username.  The SSH Key ID is an alphanumeric sequence provided by AWS IAM when importing a PUBLIC KEY for a particular user account in IAM.

For example, the original URL is:

ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/test-repo

If the SSH Key ID 1a2b3c4d5e is applied to the original SSH URL, the resulting URL would be:

ssh://1a2b3c4d5e@git-codecommit.us-east-1.amazonaws.com/v1/repos/test-repo

The modified URL can now be used as a valid repository URL via Git Integration for Jira > Connect to Git Repository.

Automatically Connect to HTTPS Git Repositories with Self-signed SSL Certificates or Other SSL issues Introduced v2.11.2

Self-signed certificates are common in HTTPS Git repositories that are hosted privately.  Even for an administrator, it's not easy to set the HTTP sslVerify to connect to this repository.

As of v2.11.2 of the Git add-on, the Jira administrator now has the option to disable sslVerify for specific repositories while inside Jira.

This feature is available in Connect to Git Repository wizard and Auto-connect integration panel for GitHub and GitLab:

  1. Connect a repository via Manage Git Repositories page.
  2. Add a remote repository by clicking GitLab in the Auto-Connect integration panel.
  3. Enter the remote URL of the private git server.
  4. Enter credentials (username and password).
  5. Click Next.
  6. If there is an indication of an SSL error, the following screen is displayed.
  7. Click Ignore certificate errors and continue connection.  This will ignore SSL verification if it's self-signed or expired.
  8. Click Next to connect to the repository or tracked repositories.
  9. Click Finish to complete the connection setup.

Manually Connect to HTTPS Git Repositories with Self-signed SSL Certificates or Other SSL Issues

When connecting to a private HTTPS git repository, a problem may be caused by a custom (self-signed) certificate.  Make sure to install the latest JRE and then change the JAVA_HOME of Jira server.

If the above solution doesn't work, see below for the steps to workaround this issue:

  1. From your Jira Server, clone the repository manually using the git client.
  2. Example:
    cd /jira/home
    cd data/git-plugin
    git clone --mirror https://my-self-signed-repo/project.git
  3. Make sure the Jira user has access to the folder above.
  4. Configure the repository to disable verification of the SSL certificate.
  5. Run git config http.sslVerify false in the repository folder.
    Example:
    cd project.git
    git config http.sslVerify false
  6. Add repository to the Git Integration Plugin using Advanced setup open in new tab.
  7. Set repository root to the folder that was used in step 1.
  8. The clone will be kept up-to-date and the SSL verification issues will be ignored.

There are alternative solutions to make Java trust this certificate.  Refer to the good articles from Atlassian which focuses on helping to resolve SSL Verification Issues:

  1. Unable to Connect to SSL Services due to PKIX Path Building Failed open in new tab
  2. Connecting to SSL services open in new tab
fyi
For connecting repositories from other git hosts, see Integration Guide.

Editing/Updating a Repository

Go to  cog Administration  > Add-ons  >  Git Integration Plugin for Jira  > Git Repositories.

The git repository configuration page can also be accessed via Dashboard menu Git > Manage repositories.

helpful tip
If using Jira 7, go to Administration  > Add-ons. Select Applications on the page tab. Under Git Integration Plugin for Jira on the sidebar, select Git Repositories.

Enable/disable a repository by clicking the checkbox under the Enabled column of the selected configured repository.

Click  cog Actions > Edit repository settings to modify repository settings.  See Adding a Repository via Advanced Setup for detailed information on the available option fields.

Managing Git Repositories via Actions

The following cog Actions are available in managing add-on configuration with the git repository.

Action (Jira Server) Action (Jira Cloud) Description

Reindex repository

Reindex

Immediately starts the synchronization with the selected repository.
Jira Server Only: This option is unavailable when the connected repository status is Disabled.

Edit repository settings

Edit

Edits the Git Integration for Jira app repository configuration.

Reset index


Clears the last indexed revision and rebuild Lucene index on next synchronization.

Remove repository

Disconnect

Removes the Git Integration for Jira app repository configuration.

View log

View log

Opens a dialog showing the indexing log of the connected repository or tracked folder.

For tracked folder or git hosts connected via auto-connect integration panel:

Action (Jira Server) Action (Jira Cloud) Description

Reindex tracked folder / Reindex integration

Reindex

Immediately starts the synchronization with the tracked folder/integration.
Jira Server Only: This option is unavailable when the connected repository status is Disabled.

Edit repository settings / Edit integration settings

Edit

Edits the tracked folder/integration repository configuration.

Reset index


Clears the last indexed revision and rebuild Lucene index on next synchronization.

Remove tracked folder / Remove integration

Disconnect

Deletes/Disconnects the tracked folder/integration add-on configuration.

View log

View log

Opens a dialog showing the indexing log of the tracked folder.

Show Tracked Repositories / Show integration repositories

Show Tracked Repositories / Show integration repositories

Opens the Tracked Repositories dialog to see the connected tracked/integration repositories of the git host.
This option is only available if the added repository is a tracked folder/repositories or git hosts connected via auto-connect having multiple repositories.

Show Integration Repositories

On the Manage Git Repositories page, click  cog Actions  > Show Integration repositories.

This action will open the Tracked Folder dialog showing the tracked repositories:

Browse the tracked repositories/folder by clicking the page controls (if more than 10 repositories are connected).

Jira Server Enable/disable the state of the connected repositories under the Enabled column.

v2.13.1 In the filter field at the top right, enter a character or a name to display repositories that contains the search text.

note
The Repository Browser will not display the repository if it is disabled in the Git Repositories configuration. The commits and code diffs in the Issue > Git Commits, Git Roll Up and Project tabs will also be unavailable due to this.

SSL Verify

The SSL Verify option is set to Enabled by default.  If set to disabled, the Git Integration for Jira add-on will disable verification of SSL certificates when connecting to a git server.

In the above example, the Repository Settings screen from Jira Cloud is shown.
fyi
The SSL Verify setting is available in both Jira Server and Jira Cloud.  This option is not available for non-fetched repositories.

Commit Message Validation

This option is only available for self-hosted git servers. For example, you are hosting your git repositories in your own server such as GitLab CE/EE or GitHub Enterprise.  If a developer tries to push a commit without the issue key in its message, the push is rejected by the Git add-on.

If this option is enabled, the commit messages are validated according to the following rules:

  • The commit message contains at least one issue key.
  • The issue key is valid.
  • The issue key exists.

View Repository Properties

Click the view cog icon to see repository details:

Setting Description
Status This is the repository connection status.
  • It shows updated if Repository Root is configured correctly and the Jira instance can access it.
  • Jira Server It shows Disabled if the Enabled status of connected repository is unchecked.
  • It shows Reindexing,Running orQueued during reindexing of the connected repository or tracked folder/repositories.
  • It shows Error if the connected repository has connection issues with the configured git host.
Last Indexed This is the date and time when synchronization was last executed.
Repository Root See Adding a Repository.
Repository Origin See Adding a Repository.
Changeset, File Added, File Modified, and File Deleted formats Displays the weblinking format strings (if set in the repository weblinking configuration).
fyi
The displayed repositories can be sorted by clicking the corresponding list header.  The add-on will remember the sorting choice per user.
note
The Repository Browser will not display the repository if it is disabled in the Git Repositories configuration. The commits and code diffs in the Issue > Git Commits, Git Roll Up and Project tabs will also be unavailable due to this.

Removing a Repository

Delete a repository if it isn't needed or is broken in the Git Plugin configuration.

  1. Go to cog Administration > Add-ons.  Under Git Integration Plugin for Jira, select Git Repositories.
  2. The git repository configuration page can also be accessed via Dashboard menu Git > Manage repositories.

    helpful tip
    If using Jira 7, go to Administration  > Add-ons. Select Applications on the page tab. Under Git Integration Plugin for Jira on the sidebar, select Git Repositories.
  3. Click Remove repository under the Actions column for the selected repository.
  4. The confirmation screen is displayed.  Uncheck the Delete repository files... option to retain git repository files in the displayed path or leave it checked to also delete the repository files from the displayed path.
  5. Click Delete to remove the repository.  Click Cancel to abort this process.

More on Integration Guides

Read our integration guides opens in new tab/window for more git integration options.

 

« Table of Contents