如何同步Git提交消息,标记消息和CHANGELOG

时间:2013-12-06 23:55:42

标签: git git-commit changelog

我想知道处理上述问题的最佳做法。我为我的项目保留了一个更改日志,我更新了有关更改的详细信息。我还在提交消息中添加了摘要,并向版本标记添加了类似的消息。但是,更新日志摘要,提交消息和标记消息之间的区别是什么?


CHANGELOG

v1.0.0 - 添加了这个和那个,并改变了它。

  • 更改1
  • 更改2
  • 改变三或某事

git commit -am“...”

添加了这个和那个,并改变了它。


git tag v1.0.0 -m“...”

v1.0.0 - 添加了这个和那个,并改变了它。


1 个答案:

答案 0 :(得分:1)

标记消息可以表示更改的摘要,而不是像提交那样的特定步骤 这些变化发生在两个标签之间。

实际上,如果您的提交邮件写得很好,您可以从中提取您的更改日志:请参阅“Very Easy Changelogs with Git

git log 1.0.0...1.1.0 --no-merges --pretty=format:'<li> %s &mdash; %cn &bull; <a href="http://github.com/<username>/<repo>commit/%H" target="_blank">%h</a></li>'

这可以生成类似于http://mun.ee/Changelog的更改日志HTML页面 这样,您就不必使用版本并维护单独的ChangeLog.md文件。


注意:启动git 2.0.x / git 2。1(2014年第3季度),标签名称将成为默认提示信息的一部分。
commit d78f340(mirabilos)

builtin/tag.c:在消息编辑器中显示标记名称

  

显示在交互式编辑期间即将添加到用户的标记名称。

相关问题