NPM ChangeLogging и автоматизация

Question

Пакеты Python имеют лучшие практики для документирования public API changes using CHANGES.txt (see an example). Существуют такие инструменты, как zest.releaser, которые выполняют автоматическое обновление публикаций и выпуска заметок.

• В пакетах NPM есть рекомендации по документированию изменений a.k.a. ChangeLog? (или люди, которые, как ожидается, будут иметь смысл в истории Github и т. д.)

• У пакета NPM есть автоматизированные инструменты для ведения журнала изменений при публикации пакетов NPM, чтобы даты выпуска и номера версий записывались в ChangeLog?

Я нашел npm-release сценарий, но его функциональность ограничена мечения и выталкивая новые пакеты НПМ.

changes.txt пример из Python:

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 plugin.

Я не имею в виду какой-либо отдельный инструмент или плагин, который позволит вам делать все, что zest.releaser делает из коробки (но это не значит, что он не существует).