我已经使用Git有一段时间了,最近我开始使用它来标记我的版本,这样我就可以更容易地跟踪更改,并能够看到每个客户端正在运行的版本(不幸的是,当前的代码要求每个客户端都有自己的PHP站点副本;我正在改变这个,但它进展缓慢)。
在任何情况下,我们开始建立一些势头,我认为能够向人们展示自上个版本以来发生了什么变化是非常好的。问题是,我一直没有维护变更日志,因为我不知道如何去做。对于这个特定的时间,我可以遍历日志并手动创建一个,但这会很快让人厌倦。
我试着在谷歌上搜索“git变更日志”和“git管理变更日志”,但我没有找到任何真正谈论代码变更工作流的内容,以及它是如何与变更日志相一致的。我们目前正在遵循Rein Henrichs的开发工作流程,我希望能有一些与之相关的东西。
我是否遗漏了一个标准的方法,或者这是一个每个人都做自己事情的领域?
你可以使用一些git日志来帮助你:
git log --pretty=%s # Only prints the subject
如果你很好地命名你的分支,这样merge to master就会显示为“Merged branch feature-foobar”,你可以通过只显示该消息来缩短内容,而不显示你合并的所有小提交,这些小提交共同构成了这个特性:
git log --pretty=%s --first-parent # Only follow the first parent of merges
您可以使用自己的脚本来增强这一点,可以做一些事情,比如去掉“合并的分支”位,规范化格式等等。当然,有时候你必须自己写。
然后你可以为每个版本创建一个新的章节:
git log [opts] vX.X.X..vX.X.Y | helper-script > changelogs/X.X.Y
然后在你的版本release commit中提交。
如果您的问题是这些提交主题与您想要放入变更日志中的内容完全不同,那么您几乎有两个选择:继续手动完成所有事情(并尝试更定期地跟上它,而不是在发布时追赶它),或者修复您的提交消息样式。
一种选择是,如果主题不打算为你做这件事,将在你的提交消息的主体中放置像“change: added feature foobar”这样的行,这样以后你就可以做一些像git log——pretty=%B | grep ^change:这样的事情来抓取那些非常重要的消息。
我不完全确定Git还能帮助您创建更改日志。也许我误解了你说的"管理"的意思?
我还为此做了一个库。它是完全可配置的胡子模板。能:
存储到一个文件中,如CHANGELOG.md。
发布到MediaWiki
或者直接打印到标准输出
我还做了:
一个Gradle插件
一个Maven插件
Jenkins插件
Bitbucket Server插件
命令行工具
更多详情见GitHub: https://github.com/tomasbjerre/git-changelog-lib
从命令行:
npx git-changelog-command-line -std -tec "
# Changelog
Changelog for {{ownerName}} {{repoName}}.
{{#tags}}
## {{name}}
{{#issues}}
{{#hasIssue}}
{{#hasLink}}
### {{name}} [{{issue}}]({{link}}) {{title}} {{#hasIssueType}} *{{issueType}}* {{/hasIssueType}} {{#hasLabels}} {{#labels}} *{{.}}* {{/labels}} {{/hasLabels}}
{{/hasLink}}
{{^hasLink}}
### {{name}} {{issue}} {{title}} {{#hasIssueType}} *{{issueType}}* {{/hasIssueType}} {{#hasLabels}} {{#labels}} *{{.}}* {{/labels}} {{/hasLabels}}
{{/hasLink}}
{{/hasIssue}}
{{^hasIssue}}
### {{name}}
{{/hasIssue}}
{{#commits}}
**{{{messageTitle}}}**
{{#messageBodyItems}}
* {{.}}
{{/messageBodyItems}}
[{{hash}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}} *{{commitTime}}*
{{/commits}}
{{/issues}}
{{/tags}}
"
或者用詹金斯的话来说:
你可以使用一些git日志来帮助你:
git log --pretty=%s # Only prints the subject
如果你很好地命名你的分支,这样merge to master就会显示为“Merged branch feature-foobar”,你可以通过只显示该消息来缩短内容,而不显示你合并的所有小提交,这些小提交共同构成了这个特性:
git log --pretty=%s --first-parent # Only follow the first parent of merges
您可以使用自己的脚本来增强这一点,可以做一些事情,比如去掉“合并的分支”位,规范化格式等等。当然,有时候你必须自己写。
然后你可以为每个版本创建一个新的章节:
git log [opts] vX.X.X..vX.X.Y | helper-script > changelogs/X.X.Y
然后在你的版本release commit中提交。
如果您的问题是这些提交主题与您想要放入变更日志中的内容完全不同,那么您几乎有两个选择:继续手动完成所有事情(并尝试更定期地跟上它,而不是在发布时追赶它),或者修复您的提交消息样式。
一种选择是,如果主题不打算为你做这件事,将在你的提交消息的主体中放置像“change: added feature foobar”这样的行,这样以后你就可以做一些像git log——pretty=%B | grep ^change:这样的事情来抓取那些非常重要的消息。
我不完全确定Git还能帮助您创建更改日志。也许我误解了你说的"管理"的意思?
gitlog-to-changelog脚本可以方便地生成一个gnu风格的ChangeLog。
如gitlog-to-changelog——help所示,您可以使用任一选项选择用于生成ChangeLog文件的提交——因为:
gitlog-to-changelog --since=2008-01-01 > ChangeLog
或者在——之后传递额外的参数,它将被传递给git-log(由gitlog-to-changelog内部调用):
gitlog-to-changelog -- -n 5 foo > last-5-commits-to-branch-foo
例如,我在顶级Makefile中使用以下规则。我的一个项目:
.PHONY: update-ChangeLog
update-ChangeLog:
if test -d $(srcdir)/.git; then \
$(srcdir)/build-aux/gitlog-to-changelog \
--format='%s%n%n%b%n' --no-cluster \
--strip-tab --strip-cherry-pick \
-- $$(cat $(srcdir)/.last-cl-gen).. \
>ChangeLog.tmp \
&& git rev-list -n 1 HEAD >.last-cl-gen.tmp \
&& (echo; cat $(srcdir)/ChangeLog) >>ChangeLog.tmp \
&& mv -f ChangeLog.tmp $(srcdir)/ChangeLog \
&& mv -f .last-cl-gen.tmp $(srcdir)/.last-cl-gen \
&& rm -f ChangeLog.tmp; \
fi
EXTRA_DIST += .last-cl-gen
该规则用于在发布时使用最新的尚未记录的提交消息更新ChangeLog。“.last-cl-gen”文件包含ChangeLog中记录的最近一次提交的SHA-1标识符,存储在Git存储库中。ChangeLog也被记录在存储库中,这样就可以在不改变提交消息的情况下对其进行编辑(例如纠正拼写错误)。