changelog.md

История изменений

Читать markdown файл с прогрессом в проекте легче, чем читать журнал коммитов.

Автоматическая генерация истории изменений из сообщений коммитов - довольно распространенная практика в настоящее время. Существует проект под названием conventional-changelog, который генерирует журнал изменений из сообщений коммитов, которые следуют соглашению.

Соглашение об именах коммитов

Наиболее распространенное соглашение - это соглашение angular, которое подробно описано здесь.

Настройка

• Установите:

npm install standard-version -D

• Добавьте script в ваш package.json:

{
  "scripts": {
    "release": "standard-version"
  }
}

• Необязательно: чтобы автоматически отправить в удаленный репозиторий новые git commit и tag плюс опубликовать в npm, добавьте скрипт postrelease:

{
  "scripts": {
    "release": "standard-version",
    "postrelease": "git push --follow-tags origin master && npm publish"
  }
}

Релизы

Просто запустите:

npm run release

На основе имён коммитов major | minor | patch вид релиза определяется автоматически. Чтобы явно указать вид, вы можете указать --release-as, например:

npm run release -- --release-as minor