Manual:Extension/IssueTrackerLinks

The IssueTrackerLinks extension handles the rendering of links to external issue tracker applications, such as GitHub, GitLab, Jira, or EasyRedmine. Administrators can define which applications are available as issue tracker links.

Configuration

A wiki administrator needs to define which issue links are tracked in the wiki. This is done on page MediaWiki:IssueTrackerLinksConfig.json. This page is pre-created and filled with common issue trackers.

The Configuration is a JSON object, where key is a unique ID for the tracker and value is an object with the following properties:

• url -
• label - optional - message key or string message to be used as a label for this tracker type
• display-mask -
• sequence -

Property	Description
url	mandatory - URL pattern for the tracker links. Any variable parts can be replaced with a variable (e.g. {repo}, {id},... ) "https://github.com/{owner}/{repo}/issues/{id}"
label	optional - message key or string message to be used as a label for this tracker type
display-mask	optional - how this tracker link should be represented in page. For example: Github: {id}, would render it as Github: 6
sequence	optional - if you want to be able to auto-convert certain sequences in VisualEditor to tracker links, specify mask here. For example, if the mask is defined as GH{id}, then any GH123 sequence will be converted to a link to the tracker with id=123, or GH:{repo},{id} for GH:example-repo,123, where repo=example-repo and id=123. Note that if the URL mask contains more variables than are present in sequence, itwill lead to broken links. Recommended is to use sequences only for URLs with one variable, such as issue IDs.

How it works

For example, an administrator has configured issue tracking for GitHub:

{
	"github": {
		"url": "https://github.com/{owner}/{repo}/issues/{id}",
		"label": "issuetrackerlinks-type-label-github",
		"icon": "github",
		"display-mask": "{owner}/{repo}#{id}"
	}
}

Copy and paste

With the above configuration, you can now paste the following link in a wiki page:

https://github.com/wikimedia/edx-platform/issues/553

The URL label will be visually formatted as an issue tracker url with the text string of the display-mask parameter that is defined for GitHub in your wiki.

GitHub issue link

Content droplet

Some issue links can be entered as content droplet:

• GitHub issue link
• GitLab issue link

Technical Reference: IssueTrackerLinks

PDF exclude - start

---

To submit feedback about this documentation, visit our community forum.

PDF exclude - end