实现变更日志

  • 3 分钟

更改日志很简单：它是一个文件，其中列出了对项目所做的更改，通常按日期进行组织。 典型格式显示版本，并为每个版本列出内容：

  • 新增功能 - 新的可执行操作
  • 已修改/改进的功能 - 效果更佳的功能
  • 已删除的功能 - 已删除的功能

某些团队将变更日志发布为博客文章。 其他人在其 GitHub 存储库中创建 CHANGELOG.md 文件。

自动更改日志工具

虽然可以手动创建和维护变更日志，但你可能希望使用自动化工具来帮助你。 至少作为一个起点。

使用原生 Git 命令

该 git log 命令可帮助你自动创建内容。 例如，为每个版本创建新节：

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Git 变更日志

一种常用的工具是 gitchangelog。 此工具是用 Python 编写的。

GitHub 更改日志生成器

另一种常用工具称为 github-changelog-generator。

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

此工具基于 Ruby Gem。

是否应使用自动生成的基于日志的数据？

通常最好避免只将日志条目复制到变更日志中。 日志包含过多的技术细节，容易使其显得杂乱无章，这不利于用户理解更改内容。