0Pricing
DevOps Bootcamp · レッスン

変更履歴とリリースノートを生成する

Git の履歴と conventional commits から、分かりやすい変更履歴と自動生成されたリリースノートを作成する方法を学びます。

「変更履歴とリリースノートを生成する」はCoddyKit上の無料DevOps Bootcampレッスンです。 これはレッスン4/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはDevOps Bootcamp学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 DevOps Bootcampコースには全4レッスンが含まれています。

変更履歴とは

変更履歴は、各バージョンの注目すべき変更を、人が読みやすい形で整理した一覧です。通常、リポジトリのルートにあるCHANGELOG.mdのようなファイルに記載します。

変更履歴が重要な理由

ユーザーやチームメンバーは、変更履歴を読んで次の内容を確認します。

  • 新機能
  • バグ修正
  • 破壊的変更

変更履歴によって、より安全かつ迅速にアップグレードできます。

Keep a Changelog形式

一般的な規約では、エントリーをAdded、Changed、Fixed、Removedという見出しの下に分類します。

## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bug

Conventional Commits

Conventional commitsでは、feat:、fix:、BREAKING CHANGE:のような接頭辞を使うため、ツールで変更履歴を自動的に作成できます。

feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 support

タグ以降のコミット一覧表示

git logでタグの範囲を指定すると、前回のリリース以降に何が変更されたかを確認できます。

git log v1.1.0..HEAD --oneline

ノート用の見やすいログ

ログを、リリースノートに貼り付けやすい箇条書きの形式に整形します。

git log v1.1.0..HEAD --pretty=format:'- %s'

変更履歴の自動生成ツール

standard-versionやconventional-changelogのようなツールは、Conventional commitsを読み取り、変更履歴のほか、バージョンの更新も自動で行います。

npx standard-version

GitHubによるリリースノートの自動生成

GitHubでは、リリースを作成すると、マージ済みのプルリクエストからリリースノートを自動生成できます。

gh release create v1.2.0 --generate-notes

ラベルによる分類

.github/release.ymlファイルでPRのラベルと変更履歴のセクションを対応付けると、バグ修正や機能のノートが自動的に分類されます。

changelog:
  categories:
    - title: Features
      labels: [feature]

公開前の確認

生成されたノートは、公開する前に必ず読みます。自動化によって下書きは作成できますが、表現の調整や破壊的変更の強調は人が行います。

リリースへのリンク

各変更履歴のエントリーをGitタグとリリースページにリンクしておくと、読者は正確な差分にすぐ移動できます。

[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0

理解度チェック

変更履歴とリリースノートについて、理解度を確認しましょう。

まとめ

変更履歴を生成する方法を学びました。

  • Keep a Changelog形式を使います
  • Conventional commitsによって自動化を実現できます
  • git log v1..HEADで変更内容を確認できます
  • gh release create --generate-notesでPRからノートの下書きを作成できます

よくある質問

「変更履歴とリリースノートを生成する」レッスンは無料ですか？

はい。「変更履歴とリリースノートを生成する」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、DevOps Bootcampコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 DevOps Bootcampコースには全4レッスンが含まれています。

「変更履歴とリリースノートを生成する」で何を学びますか？

Git の履歴と conventional commits から、分かりやすい変更履歴と自動生成されたリリースノートを作成する方法を学びます。 ブラウザで直接実行するハンズオンコードでDevOps Bootcampを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

DevOps Bootcampを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのDevOps Bootcampは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン4/4です。

「変更履歴とリリースノートを生成する」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このDevOps Bootcampレッスンでコードを書いて実行できますか？

はい。すべてのDevOps Bootcampレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

  1. タグによるセマンティックバージョニング
  2. Releaseの作成と管理
  3. ReleaseブランチとHotfix
  4. 変更履歴とリリースノートを生成する
← DevOps Bootcampに戻る