2014-01-07 21 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開箱即用(但這並不意味着它不存在)。