实现更改日志

  • 3 分钟

更改日志的概念非常简单：它是一个文件，包含对项目所做更改的列表，通常按日期顺序排列。 典型的细分方法是分离版本列表，然后在每个版本中显示：

  • 添加的功能
  • 已修改/改进的功能
  • 已删除的功能

有些团队会以博客文章的形式发布更改日志；其他团队将在 GitHub 存储库中创建 CHANGELOG.md 文件。

自动化更改日志工具

虽然可以创建和手动维护更改日志，但可能需要考虑使用自动化更改日志创建工具。 至少作为一个起点。

使用本机 GitHub 命令

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

此工具基于 Gem。

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

首选项始终是避免将日志条目转储到更改日志中。 日志具有“干扰性”，因此很容易产生无用的混乱。