723

I find a lot of answers on how to reference a GitHub issue in a git comment (using the #xxx notation). I'd like to reference a commit in my comment, generating a link to the commit details page?

0

5 Answers 5

907

To reference a commit, simply write its SHA-hash, and it'll automatically get turned into a link.

the commit 3e5c1e60269ae0329094de131227285d4682b665 solved the issue...

Or use its prefix

the commit 3e5c1e6 solved the issue...

See also:

Sign up to request clarification or add additional context in comments.

11 Comments

Note that you needn't write the full hash. As usual, a prefix (2dd190e) suffices.
please show the syntax or a link example of https://github.com/PRJ/issues/NUMBER?VERSION?
@PeterKrauss: There is no special syntax. Just write the commit hash and it automatically will be linked.
Note that this only works for commits of the repo or its forks you are writing the issue for. I have a case where my fork suddenly was unforked and I noticed this commit trick not working anymore.
You may also want to check the project name, i.e.: whether the comment you're making is the same repository that you commit code into. For me, I have a repository to record all requirements items and the other one to manage my real codes, so when I adding a comment to my requirements repository I write: repository@commit_hash
|
171

Answer above is missing an example which might not be obvious (it wasn't to me).

Url could be broken down into parts

https://github.com/liufa/Tuplinator/commit/f36e3c5b3aba23a6c9cf7c01e7485028a23c3811
                  \_____/\________/       \_______________________________________/
                   |        |                              |
            Account name    |                      Hash of revision
                        Project name              

Hash can be found here (you can click it and will get the url from browser).

enter image description here

Hope this saves you some time.

2 Comments

And you can also get it with git log, it will show up on the lines with commit <SHA>. And if that doesn't work, it could be you did not do the git push origin master. Also, there is a bug in github, there must be at least one character after the <SHA> or it doesn't get detected. It can just be a newline or a period.
Remove reference to above. It may come on top.
21

If you are trying to reference a commit in another repo than the issue is in, you can prefix the commit short hash with reponame@.

Suppose your commit is in the repo named dev, and the GitLab issue is in the repo named test. You can leave a comment on the issue and reference the commit by dev@e9c11f0a (where e9c11f0a is the first 8 letters of the sha hash of the commit you want to link to) if that makes sense.

1 Comment

This needs a correction (at least on Github) since you need username/reponame@hash in order to identify the fork.
14

Just paste the commit referencing link in the comment github automatically mentions the commit on the comment.

Comments

-2

I don't think anyone answered the question as asked, perhaps it wasn't possible a decade ago.

However now, as per the github documentation a hash is not required. It can be done thusly:

Individual account

Username/Repository# and issue or pull request number

example: for the issue at https://github.com/aUser/user-repo/issues/23

use: aUser/user-repo#26

Organization

Organization_name/Repository# and issue or pull request number

example: for the issue at https://github.com/an-org/theirproject/issues/1000

use: an-org/theirproject#1000

2 Comments

I believe the question asks how to reference a commit, not an issue/pull request.
It's not about issues. It's about commits.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.