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

Contact Support: Server  
Contact Support: Data Center  

Using the Connect Repository wizard

What’s on this page:

Getting started

Navigate to the Manage repositories page.

Figure 1: Connect wizard start screen.

To start integrating a git repository, follow the steps below:

  1. Click Connect to Git Repository. The connect repository wizard is displayed:

  2. Enter required repository location. The Repository location can be any type of supported gitl URL protocols as stated in the Location type examples.

  3. Click Next. The Connect wizard will automatically detect the provided repository location type.

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.

Do note that the Connect wizard clones the remote repository by default. It does not clone local repositories. For local repositories, the `root` is set to local path and fetches are disabled.

Starting v2.6.7+ of the Git Integration for Jira app, the default identities are not used and the repository is created without the additional key upload.

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, you can configure features such as Smart CommitsRepository Browser and Project Permission settings.

Figure 2: Settings screen at the end of the Connect wizard.

  • Smart Commits  – Enable or disable this setting to allow processing of smart commits for this repository connection.

  • Repository Browser – Enable or disable this setting to allows users to view git repositories of configured projects via the Git menu on the Jira dashboard. This feature is only available on Jira Server/DC instances.

  • For Project Permissions, set one or more projects in the Restrict to projects field to map this repository and make the Git Commits tab available in the Issue pages of the associated projects. Otherwise, leave the Associate with all projects state to associate this repository to all projects.

The level of permissions can be one of the following:

Level Process
Repository
Select a repository from the repository list. For repositories inside integrations, view the integration then select a repository within ( Actions ➜ Show integration repositories). After the selection, you will be taken to the repository properties.

Set the Project Permissions as follows:

  1. Uncheck the Associate with all projects option.
  2. Click the Restrict to project field and select one or more project(s).
  3. Save/Update the repository settings.
Integration
Select an integration from the repository list then open the integration feature properties ( Actions ➜ Edit integration feature settings).

Set the Project Permissions as follows:

  1. Uncheck the Associate with all projects option.
  2. Click the Restrict to project field and select a project.
  3. Save/Update the repository settings.
All This is the default setting where the Associate to all projects option is in state.
For Project Permissions, the View Development Tools _project permission_ must be granted to Users ➜ Group ➜ Project Roles.

Click Next.

HTTP(S) authentication

If the entered git clone URL requires HTTP credentials, the following screen appears:

Figure 3: HTTP authentication screen in the Connect wizard.

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

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

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

SSH authentication

For SSH git repository connections, the following screen is displayed for authentication:

Figure 4: SSH authentication screen in the Connect wizard.

Upload the private key file by clicking Choose File and navigate to the private key file. Otherwise, paste the private key text into the provided box.

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.

When adding a new repository that requires an SSH key, you can now pick an existing associated key in the Existing key list (see Figure 4).

Click Next to proceed.

Passphrase Input

If the generated SSH key pair has a passphrase, you will see the following screen:

Figure 4: SSH authentication screen in the Connect wizard.

Enter the Passphrase for your private key. Click Next to continue.

The passphrase screen only appears if the user has added an SSH key that requires a passphrase.

The Git Integration for Jira app will initially try 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.

This completes the setup and the newly added repository appears on the integration list on the Git Integration app repository configuration page.

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