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

• 5 分

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

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

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

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

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

カスタマイズするか、そのままにするかを選択できます。

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

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

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

   

2. .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. 新しいファイルをコミットします。

   

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

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

• リリースについて - GitHub Docs
• リリースへのリンクの - GitHub Docs
• クエリ パラメーターを使用したリリース フォームの Automation - GitHub Docs