NPM ChangeLogging和自动化

时间:2014-01-07 09:00:05

标签: npm changelog

Python包具有记录public API changes using CHANGES.txtsee an example)的最佳实践。像zest.releaser这样的工具可以自动执行包发布和发布说明维护。

  • NPM软件包是否有记录变更的最佳实践a.k.a. 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]  

1 个答案:

答案 0 :(得分:3)

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

这不是Node.js特有的。

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

Grunt是最好的构建工具之一。它非常受欢迎(直到下一个?),它可以帮助您将此阶段集成到您的发布过程中。我们可以轻松地想象使用grunt-release plugin编排更改日志任务。

我没有任何独立的工具或插件可以让你完成所有zest.releaser开箱即用(但这并不意味着它不存在)。