53

Is it possible to make a reference to an issue in Gitlab from a commit message? I haven't found anything on the web.

alayor
  • 4,537
  • 6
  • 27
  • 47

1 Answers1

90

There should be a way to reference a GitLab issue from a commit message, simply with #xx (id of the issue).
Consider "Default closing pattern value "

For example the following commit message:

Awesome commit message

Fix #20, Fixes #21 and Closes group/otherproject#22.
This commit is also related to #17 and fixes #18, #19
and https://gitlab.example.com/group/otherproject/issues/23.

will close #18, #19, #20, and #21 in the project this commit is pushed to, as well as #22 and #23 in group/otherproject.

#17 won't be closed as it does not match the pattern.

It works with multi-line commit messages as well as one-liners when used with git commit -m.

See also "Tutorial: It's all connected in GitLab"

Add references in issue or merge request descriptions or in comments.
This will update the issue with info about anything related.

  • To reference an issue: #123
  • To reference a MR: !123
  • To reference a snippet $123

pierreb adds in the comments:

Although this is not specifically asked in the original question, it may be worth adding that one can also cross-reference a previous commit in a new commit message in Gitlab.
You do it by copying the hash from the commit message you want to reference and simply pasting it in the new commit message.
Something along these lines:

This is related with commit 7as7b101

You can see (much) more in:

Fr0zenFyr adds in the comments:

Similarly, even a closed issue can be referenced like Related to #78 and #93.

VonC
  • 1,262,500
  • 529
  • 4,410
  • 5,250
  • 1
    Although this is not specifically asked in the original question, it may be worth adding that one can also cross-reference a previous commit in a new commit message in Gitlab. You do it by copying the hash from the commit message you want to reference (first eight characters are enough) and simply pasting it in the new commit message. Something along these lines: `This is related with commit 7as7b101`. – nunop Aug 01 '18 at 11:38
  • @pierreb Thank you. I have included your comment in the answer for more visibility. – VonC Aug 01 '18 at 11:41
  • Similarly, even a closed issue can be referenced like `Related to #78 and #93` – Fr0zenFyr Apr 04 '19 at 11:39
  • @Fr0zenFyr Thank you. I have included your comment in the answer for more visibility. – VonC Apr 04 '19 at 11:41
  • @VonC What is the syntax for referencing an issue in a different repository? I see you gave an example, could you elaborate? – phreed Aug 15 '19 at 12:58
  • 1
    @phreed Example: `git commit -m "Awesome commit message (Fixes #21 and Closes group/otherproject#22)"` (which is in my answer): syntax is `group/otherproject#xx`, replace `group/otherproject` by the one of your "different repository". – VonC Aug 15 '19 at 18:22