自動生成リリースノート

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

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

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

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

ご自分のエンタープライズで、リポジトリのメインページへ移動します。
ファイルの一覧の右側にある [リリース] をクリックします。
ページの上部にある [新しいリリースの下書き] を選びます。
リリースのタグを選択するには、 [タグの選択] ドロップダウンメニューを選択します。
- 既存のタグを使うには、そのタグを選びます。
- 新しいタグを作成するには、リリースのバージョン番号を入力し、 [新しいタグを作成] を選びます。
新しいタグを作成した場合は、 [ターゲット] ドロップダウンメニューを選び、リリースするプロジェクトが含まれるブランチを選びます。
必要に応じて、[説明] フィールドの上にある [前のタグ] ドロップダウンメニューを選び、次に前のリリースを特定するタグを選びます。
[リリースタイトル] フィールドに、リリースのタイトルを入力します。
説明フィールドの上にある [リリースノートの生成] をクリックします。
生成されたノートをチェックし、含めたい情報がすべて (そしてそれだけが) 含まれることを確認します。
オプションで、コンパイルされたプログラムなどのバイナリファイルをリリースに含めるには、ドラッグアンドドロップするかバイナリボックスで手動で選択します。
必要に応じて、リリースが不安定であり、運用の準備ができていないことをユーザーに通知するには、 [これはプレリリースです] を選びます。
リリースを公開する準備ができている場合は、 [リリースの公開] をクリックします。リリースの作業を後でする場合は、 [下書きの保存] をクリックします。その後、リポジトリのリリースフィードで公開されたリリースまたはドラフトリリースを表示できます。詳しくは、「リポジトリのリリースとタグを表示する」を参照してください。

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

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

構成オプション

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

# .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

# .github/release.yml

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

参考資料

「ラベルを管理する」

自動生成リリース ノート

この記事の内容

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

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

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