2014-01-07 22 views
4

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

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

回答

3

从我迄今所看到的,人们往往会建立自定义迷你工具将读取更新日志基于Git的(或其他VCS)历史记录和输出一些内部惯例。

虽然这不是特定于Node.js世界的。

实际上有几个Grunt插件,可以帮你:

步兵是最好的构建工具,有一个。它很受欢迎(直到下一个?),它可以帮助你将这个阶段整合到你的发布过程中。我们可以很容易想象用grunt-release plugin编排更改日志任务。

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