GitHub を使用してリリース ノートを自動化する

  • 5 分

リポジトリでリリース タグを作成および管理する方法を学習したら、GitHub リリース用に自動的に生成されるリリース ノートを設定する方法について説明します。

リリースに含まれる内容の概要を作成したり、自動リリース ノートをカスタマイズしたりすることもできます。

ラベルを使用してカスタム カテゴリを作成し、プル要求を整理できます。 また、特定のラベルとユーザーを出力に含めたり、出力から除外したりすることもできます。

自動生成されたリリース ノートの作成

リリースを設定するときに、タグと最後のリリースの間のすべての変更を含める [リリース ノートの自動生成] オプションがあります。 以前にリリースを作成したことがない場合は、リポジトリからのすべての変更が含まれます。

GitHub からリリース ノートを作成する方法のスクリーンショット。

カスタマイズすることも、そのままにすることもできます。

自動生成されたリリース ノート テンプレートの設定

自動生成されたリリース ノート テンプレートは、次の手順に従ってカスタマイズできます。

  1. リポジトリに移動し、新しいファイルを作成します。

    GitHub で新しいファイルを作成する方法のスクリーンショット。

  2. .github/release.yml という名前を使用して、.github ディレクトリにrelease.yml ファイルを作成します。

    GitHub でrelease.yml ファイルを作成する方法のスクリーンショット。

  3. このリリースから除外したい要求ラベルと作成者を記述するために、YAML 形式を使用します。 新しいカテゴリを作成し、それぞれにプル要求ラベルを一覧表示することもできます。 セットアップ オプションの詳細については、「 自動生成されたリリース ノート - GitHub Docs」を参照してください。

    セットアップ例:

    # .github/release.yml

changelog:
  exclude:
    labels:
    - ignore-for-release
    authors:
    - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - Semver-Major
        - breaking-change
    - title: Exciting New Features 🎉
      labels:
        - Semver-Minor
        - enhancement
    - title: Other Changes
      labels:
        - *

  4. 新しいファイルをコミットします。

    GitHub で新しいファイルをコミットする方法のスクリーンショット。

  5. 新しいリリースを作成し、[ + 自動生成 ] リリース ノートを選択して、テンプレートの動作を確認してみてください。

詳細については、以下を参照してください。