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

Contact Support
GitKraken Status  

Web linking

The web linking feature adds links to your git hosting provider directly into the Git Commits tab. Configure web linking options while adding/editing repository settings so that commits can include links to the git host pages.

Web links are automatically configured for integrations connected via the Add new integration wizard (Auto-connect setup).

 


 

Right click here to open this video in a new browser tab for more viewing options.

 

Supported git services

The following providers are supported:

  • cgit

  • Fisheye

  • GitHub

  • Gitorious

  • gitweb

  • Beanstalk

  • CloudForge

  • Atlassian Stash

  • GitLab

  • TFS (starting v2013)

  • Azure Server

  • VSTS

  • Azure DevOps

  • Gerrit

  • Bonobo

  • AWS CodeCommit

  • Bitbucket

  • Bitbucket Server

  • Gitblit

  • Gitolite

 

Web linking manual setup

GitLab web linking example

Select a git host from the Web Link list. The web linking input box options are automatically filled out with corresponding variables for the selected git host. Change the variables according to the actual URL settings of the git host. Configure server and port and ${rev} will be substituted based on the commit ID.

You can create several custom configuration to support other git hosting providers. The following five URLs should be configured for setup:

Option Description
Changeset Format This is the URL used to display revision.
Use the following variable: ${rev} – git revision
File Added Format,
File Modified Format,
File Deleted Format
This is the URL to display content of added, modified or deleted files.
Use the following variables:

  • ${num} –  number of change (0, 1, …)
  • ${rev}  –  git revision
  • ${path} –  path of the file being changed
  • ${sha256path} – sha256 applied to the path and hex encoded. NEW! in v4.17+ and is used in GitHub.com weblinking.
  • ${md5} – md5 applied to the path and hex encoded. NEW! in v4.17+ and is used in GitHub EE weblinking.
  • ${sha1path} – sha1 applied to the path and hex encoded. NEW! in v4.17+ and is used in GitLab weblinking.
  • ${parent} –  parent git revision
  • ${blob}  –  ID of blob object
  • ${parent_blob} – ID of parent blob object
  • $convert(${branch},"subStr","newSubStr") – this inline function returns branch name with subStr replaced by a newSubStr.
The ${branch} code has been changed to cope up with the character requirements on some hosting services.
View Format String. Optional. 

This URL is unused and not being configured for the newly added integration types.

The Git Integration for Jira app supports an unlimited number of repositories.

Some git hosts require web linking to be configured via the Git Integration app Advanced Setup or Actions ➜ Edit integration/repository settings screen.

The Bonobo git server requires a branch name to construct URL. Use $convert(${branch},"/","~2") for web linking since bonobo requires substitution of "/" with "~2" in the branch name.

For example:
http://<host>/Bonobo.Git.Server/Repository/<project>/$convert(${branch},"/","~2")/Commit/${rev}

Any Git host that is accessible via SSH, HTTP, HTTPS, git protocol, local and network share is supported.

Once properly configured, the Git Commits tab on the Issues page will display as follows:

Jira issue Git commits tab showing web links

The Git Integration app supports custom web linking. The commit information is displayed in the Git Commits issue tab if the git host server URL is provided on the Web Linking section in the Advanced Setup or repository settings of the connected repositories.

 


Prev: General settings

Next: Disabling Source and Commits tabs

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