セマンティックバージョニングに従ったリリースノート

リリースノートをセマンティックバージョニングの原則に合わせる方法。バージョン番号の意味、各バンプタイプに適切なコンテンツ、プレリリース識別子を解説します。

Best Practices

詳細な説明

リリースノートとセマンティックバージョニング

セマンティックバージョニング(SemVer)はバージョン番号に意味を与えます。リリースノートは、各バージョンバンプに適切なタイプの変更を含めることで、その意味を強化すべきです。

バージョン番号の意味

MAJOR.MINOR.PATCH(例:2.3.1)
  |     |     |
  |     |     +-- バグ修正のみ(後方互換)
  |     +-------- 新機能(後方互換)
  +-------------- 破壊的変更(後方互換ではない)

各リリースタイプに含めるべき内容

  • パッチリリース: FixedとSecurityカテゴリのみ。新機能や動作変更なし
  • マイナーリリース: Added、Changed、Deprecated、Fixedを含む。破壊的変更なし
  • メジャーリリース: 何でも含むが、メジャーバンプを正当化する破壊的変更が必須

プレリリース識別子

2.0.0-alpha.1  — 早期テスト、APIが変更される可能性あり
2.0.0-beta.1   — 機能完成、テストフェーズ
2.0.0-rc.1     — リリース候補、最終テスト
2.0.0          — 安定版リリース

各プレリリースは、前のプレリリースからの変更点を文書化する独自のノートを持つべきです。

ユースケース

セマンティックバージョニングに従うチームや組織全体で一貫したリリースノートの実践を確立し、バージョン番号とリリース内容が常に一致するようにする場合。

試してみる — Release Notes Generator

フルツールを開く