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.

 

The following providers are supported:

  • Beanstalk
  • BitBucket
  • BitBucket Server
  • Bonobo
  • cgit
  • CloudForge
  • Fisheye
  • Gerrit
  • Gitblit
  • GitHub
  • GitLab
  • Gitorius
  • Gitolite
  • gitweb
  • Microsoft Team Foundation Server (starting v2013)
  • Team Services (formerly Visual Studio Online)
  • Atlassian Stash
Weblinking options 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
  • ${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.  As of v2.11.0 of the Git add-on, the ${branch} code has been changed to cope up with the character requirements on some hosting services.
View Format Optional.  This URL is unused.
helpful tip
The Git Integration for Jira add-on supports an unlimited number of repositories.
note
Some git hosts require web linking to be configured via the Git add-on add/edit repository screen (Advanced Setup).
note
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:

Clickable web links in Git Commits tab
fyi
The Git add-on 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 for adding/editing repositories.