Skip to main content

自動生成リリース ノート

GitHub リリースのリリース ノートを自動的に生成できます

Who can use this feature

Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release.

自動生成リリース ノートについて

自動生成リリース ノートは、GitHub リリースのリリース ノートを手作業で記述する代わりに、自動的に生成する機能です。 自動生成リリース ノートを使うと、リリースの内容の概要をすばやく生成できます。 自動生成されたリリース ノートには、マージされた pull request の一覧、リリースの共同作成者の一覧、完全な変更ログへのリンクが含まれます。

また、自動リリース ノートをカスタマイズし、ラベルを使ってカスタム カテゴリを作成して、含める pull request をまとめたり、特定のラベルとユーザーを出力に表示しないように除外したりすることもできます。

新しいリリースの自動生成リリース ノートを作成する

  1. your enterprise で、リポジトリのメイン ページへ移動します。 1. ファイルの一覧の右側にある [リリース] をクリックします。 右側のサイドバーの [リリース] セクション
  2. [新しいリリースの下書き] をクリックします。 リリースの下書きボタン
  3. リリースのバージョン番号を入力します。 または、既存のタグを選びます。 タグ付きバージョン をリリースする
  4. 新しいタグを作成した場合は、ドロップダウン メニューを使ってリリース対象のプロジェクトを含むブランチを選択します。 タグ付きブランチのリリース
  5. 説明テキスト ボックスの右上で、 [リリース ノートの自動生成] . [リリース ノートの自動生成]をクリックします
  6. 生成されたノートをチェックし、含めたい情報がすべて (そしてそれだけが) 含まれることを確認します。
  7. オプションで、コンパイルされたプログラムなどのバイナリファイルをリリースに含めるには、ドラッグアンドドロップするかバイナリボックスで手動で選択します。 リリースに DMG ファイルを含める
  8. リリースが不安定であり、運用の準備ができていないことをユーザーに通知するには、 [これはプレリリースです] を選択します。 リリースをプレリリースとしてマークするチェック ボックス
  9. リリースを公開する準備ができている場合は、 [リリースの公開] をクリックします。 リリースの作業を後でする場合は、 [下書きの保存] をクリックします。 [リリースの公開] と [下書きの保存] ボタン

自動生成リリース ノートを構成する

  1. your enterprise で、リポジトリのメイン ページへ移動します。 1. ファイルの一覧の上にある、 [ファイルの追加] ドロップダウンを使用し、 [新しいファイルの作成] をクリックします。 [ファイルの追加] ドロップダウンの [新しいファイルの作成]
  2. ファイル名フィールドに「.github/release.yml」と入力して、.github ディレクトリに release.yml ファイルを作成します。 [新しいファイルの作成]
  3. このファイルでは、以下の構成オプションを使って、このリリースから除外する pull request ラベルと作成者を YAML で指定します。 新しいカテゴリを作成し、それぞれに含める pull request ラベルを列記することもできます。

構成オプション

パラメーター説明
changelog.exclude.labelsリリース ノートに表示しない pull request のラベルの一覧。
changelog.exclude.authorspull request をリリース ノートから除外するユーザーまたはボット ログイン ハンドルの一覧。
changelog.categories[*].title必須。 リリース ノートでの変更のカテゴリのタイトル。
changelog.categories[*].labels必須。 このカテゴリの pull request を修飾するラベル。 前のカテゴリのいずれにも一致しなかった pull request のキャッチオールとして * を使います。
changelog.categories[*].exclude.labelsこのカテゴリに表示しない pull request のラベルの一覧。
changelog.categories[*].exclude.authorspull request をこのカテゴリから除外するユーザーまたはボット ログイン ハンドルの一覧。

構成例

semver リリースにラベルを付けるリポジトリの構成

YAML
# .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:
        - "*"

pull request にはタグを付けないが、Dependabot の自動 pull request はリリース ノートで分離する必要があるリポジトリの構成 (汎用カテゴリを表示するために labels: '*' が必要です)

YAML
# .github/release.yml

changelog:
  categories:
    - title: 🏕 Features
      labels:
        - '*'
      exclude:
        labels:
          - dependencies
    - title: 👒 Dependencies
      labels:
        - dependencies

参考資料