5

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]
4

1 回答 1

3

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

不过，这并不特定于 Node.js 世界。

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

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

我没有想到任何独立的工具或插件可以让你做所有zest.releaser开箱即用的事情（但这并不意味着它不存在）。

于 2014-01-29T14:42:07.557 回答