チェンジログのマイグレーションガイド
新しいメジャーバージョンへのアップグレード時に必要な移行手順をユーザーに案内する、破壊的変更を含むチェンジログの構造化方法を学びます。
Breaking Changes
詳細な説明
破壊的変更からマイグレーションガイドへ
優れたチェンジログは破壊的変更をリストするだけでなく、ユーザーがそれについて何をすべきかを理解するのを助けます。ジェネレーターは構造的な基盤(専用のBREAKING CHANGESセクション)を作成しますが、移行ガイダンスの品質はコミットメッセージ自体に依存します。
マイグレーション対応のコミットを書く
2つのコミットメッセージを比較してください:
悪い例:
feat(api)!: update user endpoint
良い例:
feat(api)!: change /users response from object to paginated array
2番目のメッセージは何が変更されたかを正確に伝えます。これがチェンジログに表示されると、読者がマイグレーション要件を理解するのに十分なコンテキストを提供します。
マイグレーションチェンジログの構造化
メジャーバージョンリリースでは、入力コミットを整理してマイグレーションガイドのように読めるチェンジログを生成することを検討してください:
## [3.0.0] - 2026-02-27
### BREAKING CHANGES
- **api:** change /users response from object to paginated array
- **auth:** require API key header on all endpoints
- **config:** rename DATABASE_URL to DB_CONNECTION_STRING
### Added
- **api:** add cursor-based pagination to all list endpoints
- **auth:** add API key management dashboard
バージョンバンプチェックリスト
チェンジログに破壊的変更が含まれる場合、確認すること:
- バージョンがセマンティックバージョニングに従っている(メジャーバンプ)
- 各破壊的変更がアクションを導くのに十分説明的である
- 生成された出力が公開前にレビューされている
ユースケース
公開消費者がいるフレームワーク、ライブラリ、APIに不可欠です。マイグレーションに焦点を当てたチェンジログはサポート負担を軽減し、新しいメジャーバージョンの採用を加速します。