NPM ChangeLogging 和自动化

Question

Python 包具有使用 CHANGES.txt记录公共 API 更改的最佳实践（参见示例）。有像zest.releaser这样的工具可以自动进行包发布和发行说明维护。

• NPM 包是否有记录更改（又名 ChangeLog）的最佳实践？（或者人们是否希望从 Github 历史等中理解）

• NPM 包在做 NPM 包发布时是否有维护变更日志的自动化工具，以便在 ChangeLog 中记录发布日期和版本号？

我找到了npm-release脚本，但它的功能仅限于标记和推出新的 NPM 包。

来自 Python 的 CHANGES.txt 示例：

Changelog
=========

1.0.0-dev (Unreleased)
----------------------

- Added feature Z.
  [github_userid1]

- Removed Y.
  [github_userid2]


1.0.0-alpha.1 (2012-12-12)
--------------------------

- Fixed Bug X.
  [github_userid1]  

Answer 1

从我到目前为止所看到的来看，人们倾向于构建自定义的迷你工具来读取 Git（或其他 VCS）历史记录并根据一些内部约定输出变更日志。

但这并不是 Node.js 世界特有的。

实际上有几个Grunt插件可以帮助您：

• https://github.com/btford/grunt-conventional-changelog
• https://github.com/ericmatthys/grunt-changelog

Grunt 是最好的构建工具之一。它非常流行（直到下一个？），它可以帮助您将此阶段集成到您的发布过程中。我们可以轻松想象使用grunt-release 插件来编排变更日志任务。

我不认为有任何独立的工具或插件可以让您完成zest.releaser开箱即用的所有操作（但这并不意味着它不存在）。