自动将更改日志写入GitHub中的CHANGELOG.md

Question

有没有办法在GitHub存储库中自动生成从提交消息到名为CHANGELOG.md的文件的更改日志？

可以在回购中使用服务挂钩吗？

Answer 1

几个月前我写过类似的东西。它基于Git的瓷器，并使用git hook in plain bash。

您可以在Github Repo。

中找到它

Answer 2

自May 2013 File CRUD API this API以来，应该可以通过以下方式编写脚本：

• 解析git日志消息
• 使用结果更新CHANGELOG.md文件

请参阅Update file：

PUT /repos/:owner/:repo/contents/:path

你实际上可以从GitHub post-receive hook触发该脚本，除了钩子不会直接执行它，而是将JSON消息发送到你的服务器，在收到特定消息时，它会知道如何更新GitHub CHANGELOG.md文件（通过上面提到的API调用）。

Answer 3

Github-Changelog-Generator可以自动生成来自标签和合并拉取请求的更改日志。

实际上它不支持提交消息（因为它会有太多冗余信息），但它已经支持GitHub问题了。

例如：此更改日志由此脚本生成。 CHANGELOG.md

  

更新日志

     

1.2.5（2015-01-15）

     

Full Changelog

     

已实施增强功能：

     

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

     

修正了错误：

     

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

     

合并拉取请求：

     

  

• PrettyPrint课程包括使用小写＆＃39; pp＆＃39; #43（schwing）

  

• 通过命令行选项支持enterprise github #42（glenlovett）

  

Answer 4

我创建了一个GitHub应用'Changelogg.io'，以自动执行来自合并请求请求的变更日志。

它检测PR中提到的更改，并为其创建发布草案。添加发行版本后，它将自动更新CHANGELOG.md，并且还具有一个Web UI，其中包含用于生成的变更日志的过滤器。 其他一些功能：

• 由变更产生的见解（统计信息，例如错误与功能的比率，存储库随时间的趋势）
• 每个存储库的Slack集成

Youtube Walkthrough