Changelog

Last updated 2 months ago

プロジェクトの進捗状況をマークダウンで読むことは、コミットログを読むより簡単です。

コミットメッセージからのChangelog生成は、今はかなり一般的なパターンです。Convention-changelogというプロジェクトがあり、conventionに続くコミットメッセージからChangelogを生成します。

コミットメッセージの規約

もっとも一般的なのは、angularのCommitメッセージの規約です。

セットアップ

  • インストール:

npm install standard-version -D
  • あなたのpackage.jsonscriptターゲットを追加してください:

{
"scripts": {
"release": "standard-version"
}
}
  • オプション: 自動的に新しいgit commitとtagをpushして、npmにpublishする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