Skip to content

GL-NNN reference shortcut in markdown syntax

Description

I just realized that GitHub implemented this nice feature of allowing GH-NNN to reference issue #NNN (or PR #NNN) in issue/wiki/commit bodies.

Proposal

The proposal is to add a new reference shortcut with a syntax like (regex) GL-(\d+) where (\d+) is an issue or MR number.

Links / references

Oddly enough, I couldn't find a reference to this in the GitHub documentation, but the markdown-mode project uses it extensively. Here's an example: https://github.com/jrblevin/markdown-mode/commit/b163f104d83fd3eeb909920284c981e8fba1b481 - which references Github issue 240 with the string GH-240.

Documentation blurb

Will work on completing the documentation here if there's positive feedback.

Overview

  • What is it?
  • Why should someone use this feature?
  • What is the underlying (business) problem?
  • How do you use this feature?

Use cases

This is useful for repositories that cross over multiple projects. For example, projects maintainer in Debian also use the # markup to reference Debian BTS issue numbers, and those will naturally conflict with GitLab issues.

Feature checklist

Make sure these are completed before closing the issue, with a link to the relevant commit.