是否有可能在消息中自动链接到 GitHub 问题号git commit
?
8 回答
只需#xxx
在您的提交消息中包含以引用问题而不关闭它。
使用新的GitHub 问题 2.0,您可以使用这些同义词来引用问题并关闭它(在您的提交消息中):
fix #xxx
fixes #xxx
fixed #xxx
close #xxx
closes #xxx
closed #xxx
resolve #xxx
resolves #xxx
resolved #xxx
您也可以替换#xxx
为gh-xxx
.
跨 repos引用和关闭问题也有效:
fixes user/repo#xxx
查看其帮助部分中提供的文档。
如果要链接到 GitHub 问题并关闭该问题,可以在 Git 提交消息中提供以下行:
Closes #1.
Closes GH-1.
Closes gh-1.
(这三个中的任何一个都可以。)请注意,这将链接到问题并关闭它。您可以在这篇博文中了解更多信息(大约 1:40 开始观看嵌入视频)。
我不确定类似的语法是否会简单地链接到一个问题而不关闭它。
如果提交包含#issuenbr(偶然发现),github 会添加对提交的引用。
您还可以交叉引用存储库:
githubuser/repository#xxx
xxx 是问题编号
他们在博客 https://github.blog/2011-04-09-issues-2-0-the-next-generation/上写了一篇关于新问题 2.0 的精彩文章
同义词包括
- 修复#xxx
- 固定#xxx
- 修复#xxx
- 关闭#xxx
- 关闭#xxx
- 关闭#xxx
在提交消息中使用任何关键字都会使您的提交被提及或关闭问题。
为了将问题编号链接到您的提交消息,您应该
#issue_number
在您的 git 提交消息中添加:
来自Udacity Git 提交消息样式指南的示例提交消息
feat: Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded
by a single space, with blank lines in between, but conventions
vary here
If you use an issue tracker, put references to them at the bottom,
like this:
Resolves: #123
See also: #456, #789
您还可以参考存储库:
githubuser/repository#issue_number
就像其他答案一样:如果您甚至不想使用问题编号编写提交消息并且碰巧使用Eclipse进行开发,那么您可以安装 eGit 和 Mylyn 插件以及 Mylyn 的 GitHub 连接器。然后 Eclipse 可以自动跟踪您正在处理的问题并自动填写提交消息,包括所有其他答案中显示的问题编号。
有关该设置的更多详细信息,请参阅http://wiki.eclipse.org/EGit/GitHub/UserGuide
作为程序员,我的第一个项目是一个名为stagecoach的 gem ,它(除其他外)允许自动将 github 问题编号添加到分支上的每个提交消息中,这是尚未真正回答的问题的一部分.
本质上,在创建分支时,您将使用自定义命令(类似stagecoach -b <branch_name> -g <issue_number>
),然后将问题编号分配给 yml 文件中的该分支。然后有一个提交钩子自动将问题编号附加到提交消息中。
我不会推荐它用于生产,因为当时我只编程了几个月并且我不再维护它,但它可能会引起某些人的兴趣。