使用 Git 管理变更日志有哪些好方法？

Question

Closed. This question needs to be more focused. It is not currently accepting answers.

---

想要改进这个问题？通过编辑这篇文章来更新问题，使其仅关注一个问题。

3 年前已关闭。

社区6个月前审查了是否重新开放此问题，并将其关闭：

原始关闭原因未解决

Answer 1

那是在 2015 年，但为了未来的搜索者，现在可以通过以下方式生成华丽的日志：

git log --oneline --decorate

或者，如果您希望它更漂亮（带有终端的颜色）：

git log --oneline --decorate --color

将该输出通过管道传输到 ChangeLog这是我目前在所有项目中使用的，它简直太神奇了。

Answer 2

您可以使用 git log 的一些风格来帮助您：

git log --pretty=%s                 # Only prints the subject

如果您很好地命名了您的分支，以便合并到 master 显示为类似“合并分支功能-foobar”的内容，您可以缩短时间通过仅显示该消息，而不是您合并的所有小提交，它们一起形成了该功能：

git log --pretty=%s --first-parent  # Only follow the first parent of merges

您也许可以使用自己的脚本来增强此功能，该脚本可以执行诸如删除“合并分支”位之类的操作，当然，在某些时候你必须自己编写它。

然后，您可以为每个版本的变更日志创建一个新部分：

git log [opts] vX.X.X..vX.X.Y | helper-script > changelogs/X.X.Y

并在您的版本发布提交中提交该部分。

如果您的问题是这些提交主题与您想要放入变更日志中的内容不同，那么您几乎有两个选择：继续手动完成所有操作（并尝试更定期地跟上它，而不是玩追赶游戏-在发布时更新），或者修复您的提交消息样式。

如果主题不打算为您执行此操作，一种选择是在提交消息的正文中放置诸如“change：added feature foobar”之类的行，以便稍后您可以执行诸如 git log 之类的操作--漂亮=%B | grep ^change: 仅抓取消息中那些超级重要的部分。

我不完全确定 Git 能真正帮助您创建变更日志多少。也许我误解了你所说的“管理”的意思？

Answer 3

TL;DR：您可能需要检查 gitchangelog 自己的变更日志 或生成前一个的 ASCII 输出。

如果您想从 Git 历史记录生成变更日志，您可能需要考虑：

• 输出格式。 （纯自定义 ASCII，Debian 变更日志类型，降价，休息 等）
• 一些提交过滤（您可能不希望看到更改日志中出现所有拼写错误或修饰性更改）
• 一些提交文本争论在包含之前在变更日志中。 （确保消息标准化为首字母大写或最后一个点，但它也可能会删除摘要中的一些特殊标记。）
• 您的 Git 历史记录兼容吗？大多数工具并不总是那么容易支持合并和标记。这取决于您如何管理您的历史记录。

或者，您可能需要一些分类（新事物、更改、错误修复等）。

考虑到这一切，我创建并使用了 gitchangelog。它旨在利用 Git 提交消息约定来实现之前的所有目标。

创建良好的变更日志必须遵守提交消息约定（无论是否使用 gitchangelog）。

提交消息约定

以下是关于在提交消息中添加可能有用的内容的建议。

您可能希望将您的提交粗略地分成几个大的部分：

• 按意图（例如：新的、修复、更改等）
• 按对象（例如：文档、打包、代码等）
• 按受众（例如：开发、 这些

此外，您可能希望将一些提交标记为“次要”提交，

• 提交不应输出到您的变更日志（外观更改、注释中的小拼写错误等），
• 如果您实际上没有任何重大的功能变化。因此，这也不应该成为向最终用户显示的变更日志的一部分，但如果您有开发人员变更日志，它可能会引起一些兴趣。
• 您还可以使用“API”标记来标记 API 更改或新的 API 内容...
• ...等等...

尝试通过尽可能频繁地定位用户（功能）来编写提交消息。

示例

这是标准的git log --oneline，用于显示如何存储此信息::

* 5a39f73 fix: encoding issues with non-ASCII characters.
* a60d77a new: pkg: added ``.travis.yml`` for automated tests.
* 57129ba new: much greater performance on big repository by issuing only one shell command for all the commits. (fixes #7)
* 6b4b267 chg: dev: refactored out the formatting characters from Git.
* 197b069 new: dev: reverse ``natural`` order to get reverse chronological order by default. !refactor
* 6b891bc new: add UTF-8 encoding declaration !minor

因此，如果您注意到了，我选择的格式是：

{new|chg|fix}: [{dev|pkg}:] COMMIT_MESSAGE [!{minor|refactor} ... ]

查看实际输出结果，您可以查看PyPI页面的末尾https://pypi.python.org/pypi/gitchangelog" rel="nofollow noreferrer">gitchangelog。

要查看我的提交消息约定的完整文档，您可以查看参考文件 gitchangelog.rc.reference。

如何由此生成精美的变更日志

然后，制作完整的变更日志就很容易了。您可以很快地创建自己的脚本，或者使用 gitchangelog。

gitchangelog 将生成完整的变更日志（分段支持为 New、Fix...），并且可以根据您自己的提交约定进行合理配置。由于通过 Mustache、Mako 模板 进行模板化，它支持任何类型的输出，并且有一个用原始 Python 编写的默认遗留引擎；当前的所有三个引擎都有如何使用它们的示例，并且可以输出更改日志，如 gitchangelog 的 PyPI 页面上显示的那样。

我相信您知道还有很多其他的 git log 到 changelog 工具。

_{免责声明：我是 gitchangelog 的作者我将在下面谈到这一点。}

Answer 4

更切题的变更日志：

git log --since=1/11/2011 --until=28/11/2011 --no-merges --format=%B

Answer 5

gitlog-to-changelog 脚本可以方便地生成 GNU 风格的 ChangeLog。

如gitlog-to-changelog --help所示，您可以使用选项--since选择用于生成ChangeLog文件的提交>：

gitlog-to-changelog --since=2008-01-01 > ChangeLog

或者在 -- 之后传递附加参数，这些参数将传递给 git-log （由 gitlog-to-changelog 在内部调用） ：

gitlog-to-changelog -- -n 5 foo > last-5-commits-to-branch-foo

例如，我在我的一个项目的顶级 Makefile.am 中使用以下规则：

.PHONY: update-ChangeLog
update-ChangeLog:
    if test -d $(srcdir)/.git; then                         \
       $(srcdir)/build-aux/gitlog-to-changelog              \
          --format='%s%n%n%b%n' --no-cluster                \
          --strip-tab --strip-cherry-pick                   \
          -- $(cat $(srcdir)/.last-cl-gen)..               \
        >ChangeLog.tmp                                      \
      && git rev-list -n 1 HEAD >.last-cl-gen.tmp           \
      && (echo; cat $(srcdir)/ChangeLog) >>ChangeLog.tmp    \
      && mv -f ChangeLog.tmp $(srcdir)/ChangeLog            \
      && mv -f .last-cl-gen.tmp $(srcdir)/.last-cl-gen      \
      && rm -f ChangeLog.tmp;                               \
    fi

EXTRA_DIST += .last-cl-gen

此规则用于在发布时使用以下内容更新 ChangeLog最新的尚未记录的提交消息。文件 .last-cl-gen 包含 ChangeLog 中记录的最新提交的 SHA-1 标识符，并存储在 Git 存储库中。 ChangeLog 也记录在存储库中，以便可以对其进行编辑（例如纠正拼写错误）而无需更改提交消息。

Answer 6

由于为每个版本创建一个标签是最佳实践，因此您可能希望对每个版本的变更日志进行分区。在这种情况下，此命令可以帮助您：

git log YOUR_LAST_VERSION_TAG..HEAD --no-merges --format=%B

Answer 7

我还为此创建了一个库。它完全可以通过 Mustache 模板进行配置。可以：

• 存储到文件中，例如 CHANGELOG.md。
• 发布到 MediaWiki
• 或者只是打印 我还制作了标准输出

：

• A Gradle 插件
• A Maven 插件
• A Jenkins 插件
• A Bitbucket 服务器插件
• 一个命令行工具

更多详细信息请参见 GitHub：https://github.com/tomasbjerre/git-changelog-lib< /a>

从命令行：

npx git-changelog-command-line -std -tec "
# Changelog

Changelog for {{ownerName}} {{repoName}}.

{{#tags}}
## {{name}}
 {{#issues}}
  {{#hasIssue}}
   {{#hasLink}}
### {{name}} [{{issue}}]({{link}}) {{title}} {{#hasIssueType}} *{{issueType}}* {{/hasIssueType}} {{#hasLabels}} {{#labels}} *{{.}}* {{/labels}} {{/hasLabels}}
   {{/hasLink}}
   {{^hasLink}}
### {{name}} {{issue}} {{title}} {{#hasIssueType}} *{{issueType}}* {{/hasIssueType}} {{#hasLabels}} {{#labels}} *{{.}}* {{/labels}} {{/hasLabels}}
   {{/hasLink}}
  {{/hasIssue}}
  {{^hasIssue}}
### {{name}}
  {{/hasIssue}}

  {{#commits}}
**{{{messageTitle}}}**

{{#messageBodyItems}}
 * {{.}}
{{/messageBodyItems}}

[{{hash}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}} *{{commitTime}}*

  {{/commits}}

 {{/issues}}
{{/tags}}
"

或者在 Jenkins 中：

Answer 8

我让 CI 服务器将以下内容通过管道传输到名为 CHANGELOG 的文件中对于每个新版本，其日期在版本文件名中设置：

git log --graph --all --date=relative --pretty=format:"%x09 %ad %d %s (%aN)"

Answer 9

GNU 风格变更日志

对于 GNU 风格变更日志，我已经完善了该功能：

gnuc() {
  {
    printf "$(date "+%Y-%m-%d")  John Doe  <[email protected]>\n\n"
    git diff-tree --no-commit-id --name-only -r HEAD | sed 's/^/\t* /'
  } | tee /dev/tty | xsel -b
}

这样：

• 在对变更日志进行最终编辑之前，我定期提交更改以备份和变基，
• 然后运行： gnuc

现在我的剪贴板包含类似以下内容：

2015-07-24  John Doe  <[email protected]>

        * gdb/python/py-linetable.c (): .
        * gdb/python/py-symtab.c (): .

然后我使用剪贴板作为更新变更日志的起点。

它并不完美（例如，文件应该相对于其 ChangeLog 路径，因此 python/py-symtab.c 没有 gdb/ 因为我将编辑 gdb /ChangeLog），但这是一个很好的起点。

更高级的脚本：

• git-gnu-changelog，作者：Tromey，GDB 维护者
• GCC 的 contrib/mklog
• gcc/contrib/mklog

不过，我必须同意 Tromey 的观点：在更改日志没有用。

如果您要制作变更日志，请对其进行良好的总结，可能如保留变更日志。

Answer 10

git log --oneline --no-merges `git describe --abbrev=0 --tags`..HEAD | cut -c 9- | sort

是我喜欢用的。它获取自最后一个标签以来的所有提交。 cut 删除提交哈希。如果您在提交消息的开头使用票证编号，它们将按 sort 分组。如果您在某些提交前加上 fix、typo 等前缀，排序也会有所帮助。

Answer 11

基于bithavoc，下面列出了最后一个标签直到HEAD 。但我希望列出两个标签之间的日志。

// Two or three dots between `YOUR_LAST_VERSION_TAG` and `HEAD`
git log YOUR_LAST_VERSION_TAG..HEAD --no-merges --format=%B

列出两个标签之间的日志：

// Two or three dots between two tags
git log FROM_TAG...TO_TAG

例如，这将列出从 v1.0.0 到 v1.0.1 的日志：

git log v1.0.0...v1.0.1 --oneline --decorate

---