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

  • 2 分

リポジトリでリリース タグを作成および管理する方法を学習したら、GitHub リリースから自動生成されたリリース ノート テンプレートを構成する方法について学習します。

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

ラベルを使用してカスタム カテゴリを作成し、出力に表示される特定のラベルとユーザーを含める、または除外する pull request を整理できます。

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

リリースの構成中に、タグと最後のリリースの間の変更をすべて含めるための [リリース ノートの自動生成] オプションが表示されます。 リリースを作成したことがない場合は、リポジトリのすべての変更で構成されます。

Screenshot of how to create release notes from GitHub.

カスタマイズするか、そのままにするかを選ぶことができます。

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

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

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

    Screenshot of how to create a new file on GitHub.

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

    Screenshot of how to create release.yml file on GitHub.

  3. YAML でこのリリースから除外する pull request のラベルと作成者を指定します。 新しいカテゴリを作成し、それぞれの pull request ラベルの一覧を表示することもできます。 構成オプションの詳細については、「自動生成されたリリース ノート - 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. 新しいファイルをコミットします。

    Screenshot of how to commit new file on GitHub.

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

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