16

我是git的菜鸟，我想知道创建标签和生成/维护变更日志的最佳实践。

到目前为止，我总是创建一个 readme.md 并手动指出（在“更改日志”部分）最重要的功能

例如：

版本 1.0.1

  • 改变了家里的布局
  • 在图库中添加幻灯片
  • ETC..

如何创建具有这些特征的变更日志（可能是降价格式）？

  • 基于个性化标题/标签标题/日期的更改标题
  • 基于标签或提交的更改

我还没有一个明确的想法，所以建议很重要

提前致谢 ：）

4

3 回答 3

15

目前还没有一些通用的指导方针。但是在保持更新日志中解释了很多好的规则。

正如他们提到的：

不要让您的朋友将 git 日志转储到更改日志中。

我完全同意。

这就是我创建GitHub Changelog Generator的原因，它根据所有这些准则生成更新日志。

实际上它仅适用于 GitHub，但它提供了一个很好的示例来说明变更日志的外观。

它会根据您的标签、问题、标签和拉取请求自动生成变更日志。

例如：这个变更日志是由这个脚本生成的：CHANGELOG.md

变更日志

1.2.5 (2015-01-15)

完整的变更日志

实施的增强功能：

  • 使用里程碑指定修复了哪个版本的错误#22

修复的错误：

  • 尝试为没有标签的 repo 生成日志时出错#32

合并的拉取请求：

于 2015-03-11T11:41:29.070 回答
3

我建议您仍然手动描述更改日志中的更改。

艰难，您可以通过 github diff 链接到生成的更改。例如变更日志： https ://github.com/rspec/rspec-core/blob/master/Changelog.md

和差异： https ://github.com/rspec/rspec-core/compare/v2.14.2...master

您可能想在其他一些参考开源项目的存储库中四处查看，其中可以找到很多好的实践。

于 2013-08-12T11:24:05.857 回答
3

可能我的 Asnwer 来不及了，但现在我正在使用一个神奇的 ruby​​ gem，它读取你的 git log 并按标签拆分，输出是用 markdown 写的，看看

https://github.com/kebab-project/katip

于 2013-09-06T15:33:59.553 回答