【チェンジログ】
CHANGELOG とは?
💡 ソフトウェアの「成長日記」、何がいつ変わったか一目でわかる
📌 このページのポイント
- ソフトウェアのバージョンごとに「何が変わったか」を時系列で記録するドキュメント
- Added(追加)、Changed(変更)、Fixed(修正)、Removed(削除)などのカテゴリで整理するのが一般的
- Keep a Changelog という書き方の標準があり、セマンティックバージョニングと組み合わせて使うことが多い
- リリースノートとは異なり、開発者向けの技術的な変更内容を網羅的に記録する
CHANGELOGって何のために書くの?
Gitのコミットログとは違うの?
いい質問だね。コミットログは開発者が細かい作業単位で残すメモで、数百件にもなるよ。CHANGELOGはそれを人間が読みやすいようにまとめたもので、「このバージョンでは何が追加されて、何が修正されたか」がすぐわかるように整理されているんだ。
どうやって書くの?決まった形式はあるの?
自動で作れたりしないの?
conventional-changelog や standard-version のようなツールを使えば、コミットメッセージから自動生成できるよ。ただしコミットメッセージを「feat:」「fix:」のような規約に従って書く必要があるんだ。Conventional Commits という規約が有名だね。
CHANGELOGを書かないとどうなるの?
まとめ:ざっくりこれだけ覚えればOK!
「CHANGELOG」って出てきたら「ソフトウェアの変更履歴をバージョン別にまとめたファイル」と思えればだいたいOK!
📖 おまけ:英語の意味
「Change Log」 = 変更記録
💬 change(変更)とlog(記録)を組み合わせた言葉で、プロジェクトのルートに CHANGELOG.md として置くのが慣習だよ