« Table of Contents

Managing Repository/Integration Configuration

Manage connected repositories or integration via the Actions commands on the git configuration page.

Introduction

After successfully connecting your git repositories or integrating your git host via Git Integration for Jira app, you can change repository settings depending on the connection protocol of the repository or integration.

On the git repository configuration page, you can manage connected repositories and integration such as enabling/disabling repository connection/integration (Jira Server only), edit/update repository/integration settings or disconnect repositories/integrations.

Getting Started

Jira Server Data Center
Manage git repositories page - Jira Server/Data Center
Jira Cloud
Manage git repositories page - Jira Cloud

For the repository/integration list, utilize the following references for the column items:

Column Description

Enabled

Enables/disables an integration for use in Jira. For disabled integrations, repository information and function such as commits, pull/merge request, git viewer and etc are not available.
Jira Server Data Center

Location

Displays a short identifier where the integration is located. For example, HOSTED is displayed for self-hosted integration; FOLDER for tracked folder or EXTERNAL for remoted-hosted integration. Some supported git host integration are also displayed here.
Jira Server Data Center

Repository / Integration

Displays the repository name, integration name or integration URL.
Jira Server Data Center Jira Cloud
Jira Server Data Center
While you can change the name displayed for this column, some integration names does not allow to be changed.

Last indexed

Shows how long the time the integration was last indexed.
Jira Server Data Center

Last indexer check

Shows the date and time the indexing service has checked if the repository should be examined for changes.
Jira Cloud
For more information on Jira Cloud indexer, see Jira Cloud: Indexing Explainer.

Status

Shows the index status of the integration.
  • It shows updated if Repository Root is configured correctly and the Jira instance can access it.
  • Jira Server/Data Center 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.
Jira Server Data Center Jira Cloud

Actions

To the right of the Status colum are actions that can be performed for the selected connected repository/integration.
Clicking the Actions icon will open a context menu with a set of functions for managing integrations. The Actions sub-menu functions will depend on the type of integration you were working on. For more information, see Managing Integration via Actions for your specific platform: Jira Cloud, Jira Server/Data Center.
Jira Server Data Center Jira Cloud

Managing Integration via Actions (Jira Cloud)

After integrating your repository or git host, a set of Actions can be performed by clicking the icon under the Actions column on the repository/integration configuration list.

Utilize the following actions to manage connected integrations in Jira Cloud:

Action Description

Reindex integration

Immediately starts the synchronization with the selected repository.

Show integration repositories

Opens the Tracked folder dialog to manage repositories for this integration. Clicking on the Last indexer success date/time will reveal indexing information for the selected repository. Clicking on a repository name will open the integration settings for the selected repository. For detailed information on this function, see below.

Edit integration settings

Opens the page to manage repository settings for the selected integration. See integration and repository level configuration below.

Remove integration

Disconnects the selected integration and removes its settings from the Git Integration for Jira app repository configuration.

View log

Opens a dialog showing the indexing log of the selected integration.

Edit integration settings (Jira Cloud)

The repository configuration can be setup using the following methods:

Integration level

For the selected integration, click Actions > Edit integration settings. The page for managing integration settings is displayed.

Utilize the following options to configure integration settings:

Manage <integration> repository

Personal Access Token  –  If the PAT for this integration is expired or changed, enter the new PAT on the provided box.

Webhook URL  –  This is the webhook URL that will be used in your git host Webhook integration settings.

Integration Settings

The rest of the integration settings are self-explanatory:

Require User PAT  –  Toggle to enable/disable this feature.

Custom API Path  –  Filters which repositories are displayed/accessible in the Show integration repositories action.

JMESPath Filters  –  Does the same with Custom API Path but with more options.

Project Permissions

Restrict to projects  –  Uncheck Associate with all projects option and enter/select one or more projects to associate this integration to specified projects. The Git Commits and the Repository Browser feature are available to the specified repositories.

Repository level

For the selected integration, click Actions > Show integration repositories. The page for managing repository settings is displayed.

Utitlize the following options to configure repository settings:

Repository settings

Repository origin  –  This is the URL to the hosted git service used on the project. (Read-only)

Main Branch  –  Specify branch if your repository has no master branch. Leave blank if master branch is present.

Tags  –  Set to show all tags or show only tags that matches the regex pattern.

For example: release2[.](7|8)[.][0-9]+

This above example is a filtering regexp for a range of releases from 2.7.x to 2.8.x and is displayed on the developer panel in decending order.

Smart Commits & Workflow Triggers  –  Enable/disable this feature for this repository.

Webhook URL  –  Use this URL to configure webhooks in your git host.

Project Permissions

Restrict to projects  –  Uncheck Associate with all projects option and enter/select one or more projects to associate this repository to the specified projects. The Git Commits and the Repository Browser feature are available to the specified projects.

Managing Integration via Actions (Jira Server/Data Center)

After integrating your repository or git host, a set of Actions can be performed by clicking the icon under the Actions column on the repository/integration configuration list.

The set of functions depends on what type of integration or repository connection is selected:

HOSTED and EXTERNAL (Single repository)
Action Description

Reindex repository

Immediately starts the synchronization with the selected repository.
Jira Server Data Center
If the repository is disabled, this option is not available.

Edit repository settings

Opens the Git Repository - Advanced page where you can change the settings of the selected connected repository. See details below.

Reset index

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

Remove repository

Disconnects the repository and removes its settings from the Git Integration for Jira app repository configuration.

View log

Opens a dialog showing the indexing log of the connected repository.
FOLDER (Tracked folder)
Action Description

Show tracked repositories

Opens the Tracked Repositories dialog to view the connected tracked folder repositories. This option is only available if the added repository is a tracked folder. For more information about this function, see below.

Edit repository settings

Opens the Git Repository - Advanced page where you can change the settings of the selected tracked folder integration. See details below.

Reset index

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

Remove tracked folder

Disconnects the tracked folder integration and removes its settings from the Git Integration for Jira app repository configuration.

View log

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

Edit repository settings (Hosted/External/Folder)

This Action opens the Git Repository - Advanced page where you can change the settings of the selected connected repository: HOSTED, EXTERNAL or FOLDER.

Utilize the options below for configuring repository settings:

Option Description Integration

Display Name

This is the alias that will appear in the Repository/Integration column.

HOSTED, EXTERNAL, FOLDER

Key

This is the key name for this repository connetion.

HOSTED

Absolute Repository Root

This is the calculated absolute path of the clone repository root on the same machine as Jira.

HOSTED, EXTERNAL, FOLDER

Clone root location

Set to automatically managed or manually configured by Jira admin.

HOSTED, EXTERNAL, FOLDER

Repository Root

This is the path to a clone of the repository.

HOSTED, EXTERNAL

Enable Fetches

Set to either hosted at remote server or hosted on the same server as Jira.

EXTERNAL

Main Branch

Set the main branch. Default is master.

HOSTED, EXTERNAL

Use HTTP(S) Authentication

If this repository connection supports HTTP(S)) authentication, you may enter required credentials here.

EXTERNAL

SSL Verify

Enable/Disable. If set to disabled, the Git Integration for Jira app will ignore verification of SSL certificates when connecting to a remote Git server.

EXTERNAL

Advanced: Revision Indexing and Revision Cache Size

Set Revision Indexing and Revision Cache Size as desired.

EXTERNAL, FOLDER

Repository Browser

Enabled/Disabled. When enabled, it allows users to view Git repositories of configured projects. For more information, see Repository Browser.

HOSTED, EXTERNAL, FOLDER

Tags

Set whether to show all tags or show on tags with matching regex pattern. For more information on git tags, see Git Tags.

HOSTED, EXTERNAL, FOLDER

Project Permissions: Restrict to projects

The default setting is Associate with all projects. You can restrict access to the Repository Browser and Git Commit tabs (Advanced) for the selected repository by setting the project associations.

HOSTED, EXTERNAL, FOLDER

Source Code Diff Viewing

Allows users to view the diff by commit and file.

HOSTED, EXTERNAL, FOLDER

Smart Commits

Allows the users to use the smart commits feature.

HOSTED, EXTERNAL, FOLDER

Commit Message Validation

Turn the setting on to reject/ignore any commit that does not reference a valid Jira issue key.

HOSTED

Commit Notification Emails

Enable/disable this setting to allow sending of commit notification emails. Set the Max commit age (in minutes) as desired. Commit notifications will be e-mailed if the age of the commit is less than or equal to this value.

HOSTED, EXTERNAL, FOLDER

Web Linking

Optional. The web linking feature adds links to your git hosting provider directly into the Git Commits tab. For special integrations (Auto-Connect), this feature is configured automatically. For more information on about this topic, see Web Linking.

EXTERNAL
AUTO-CONNECT (Integration)
Action Description

Reindex integration

Immediately starts the synchronization with the selected repository.
Jira Server Data Center
If the integration is disabled, this option is not available.

Show integration repositories

Opens the Tracked folder dialog to manage multiple repositories for this integration. You can enable/disable connected repositories individually. Clicking a repository name will open the connection settings for the selected repository. For more information about this function, see below.

Edit integration connection settings

Opens the Integration Connection Settings page where you can change the connection settings of the selected integration. For more details on the settings, see below.

Edit integration feature settings

Opens the Integration Feature Settings page where you can change the feature settings of the selected integration. For more details on the settings, see below.

Reset index

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

Remove integration

Disconnects the selected integration and removes its settings from the Git Integration for Jira app repository configuration.

View log

Opens a dialog showing the indexing log of the selected integration.

The tracked folder and auto-connect integrations can be configured using the following methods:

  • Integration level  –  Click Actions > Edit integration connection settings. This will open the settings for the selected integration.
  • Repository level  –  Click Actions > Show integration repositories. Click a repository from the list to open the settings for the selected repository.

Show Tracked/Integration Repositories

On the Manage Git Repositories page, click the icon under the Actions column then select:

  • For tracked folders  –  Show tracked repositories.
  • For auto-connect integrations  –  Show integration repositories.

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

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

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.

Jira Server Data Center
Enable/disable the state of the connected repositories under the Enabled column.
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.

Back to: Show integration repositories (Jira Cloud), Show tracked repositories, Show integration repositories.

Edit Integration Connection Settings

Clicking Actions > Edit integration connection settings opens the configuration page for integration connection settings.

Utilize the following options to configure the selected integration:

Option Description

Display Name

This is the name that will appear on the Repository/Integration column.

Personal Access Token

If the PAT has expired or changed, enter the new PAT on the provided box.

SSL Verify

The Git Integration for Jira app will enforce/ignore verification of SSL certificated when connecting to a git server. For more information, see SSL Verify.

Custom API Path

The Git Integration for Jira app supports this feature for GitHub and GitLab integrations. For more details, see Working with Custom API Path.

JMESPath Filters

JMESPath is a query language for JSON used to filter API results and to limit which repositories are integrated. For more information, see Working with JMESPath Filters.

Back to: Auto-connect connection settings.

Edit Integration Feature Settings

Clicking Actions > Edit integration feature settings opens the configuration page for integration features settings.

Utilize the following options to configure the selected integration:

Option Description

Repository Browser

Enabled/Disabled. When enabled, it allows users to view Git repositories of configured projects. For more information, see Repository Browser.

Personal Access Token: Require User PAT

Enable this option to require users to provide PAT which will be used for branch and merge/pull request creation/deletion (via the developer panel on the Jira issue page). This is a security feature of Git Integration for Jira app for git hosts that support two-factor authentication. This option requires the Repository Browser feature to be enabled.

This setting is only available for auto-connected git hosts in Jira Server and Data Center.

Tags

Set whether to show all tags or show on tags with matching regex pattern. For more information on git tags, see Git Tags.

Project Permissions: Restrict to projects

The default setting is Associate with all projects. You can restrict access to the Repository Browser and Git Commit tabs (Advanced) for the selected repository by setting the project associations.

Source Code Diff Viewing

Allows users to view the diff by commit and file.

Smart Commits

Allows the users to use the smart commits feature.

Commit Notification Emails

Enable/disable this setting to allow sending of commit notification emails. Set the Max commit age (in minutes) as desired. Commit notifications will be e-mailed if the age of the commit is less than or equal to this value.

Back to: Auto-connect feature settings.

SSL Verify

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

In the above example, the Repository Settings screen from Jira Cloud is shown.
The SSL Verify setting is available in both Jira Server, Data Center 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/Data Center 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 This is the local path to the repository on the server where your Jira service is running.
Repository Origin This is the URL to the hosted git service used on the project.
Changeset, File Added, File Modified, and File Deleted formats Displays the weblinking format strings (if set in the repository weblinking configuration).
The displayed repositories can be sorted by clicking the corresponding list header.  The add-on will remember the sorting choice per user.
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 Configuration

Delete a repository if it isn't needed or is broken in the Git Integration for Jira app configuration.

  1. On your Jira Server/Data Center dashboard, go to Administration > Applications. Under Git Integration for Jira on the sidebar, click Git Repositories.

    For Jira Cloud, go to Jira Settings > Apps > Manage Git repositories.

  2. Alternatively, the git repository configuration page can also be accessed via Dashboard menu Git > Manage (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.

 

« Table of Contents