GitHub Releasesにリリースノートを自動生成する新機能。テンプレートでのカスタマイズも可能

GitHubは、GitHub Releasesの新機能としてリリースノートを自動生成する「auto-generated release notes」をパブリックベータとして公開したと発表しました。

Releases on GitHub are now…

Easier to compile and share
Optimized to recognize and celebrate your contributors
Built to encourage more engagement from your community

See everything that’s new for releases: https://t.co/zQt2HFBEPp pic.twitter.com/aLmjlDJ7Xn

— GitHub (@github) October 4, 2021

GitHub Releasesは、ユーザーがGitHub上で開発されているソフトウェアを入手し利用しやすいように、ソフトウェア、リリースノート、バイナリファイルへのリンクをまとめたページなどを作成する機能を備えています。

アップデートされたソフトウェアがリリースされるたびに、リリースページにはどのような変更や新機能の追加が行われたのかがリリースノートとして示されるのが一般的です。

今回公開された新機能「auto-generated release notes」は、このリリースノートを自動生成してくれるというものです。

赤で囲った部分に「Auto-generate release note」ボタンが見えます。

どのようにリリースノートを自動作成するかは、「A new public beta of GitHub Releases: How we’re improving the release experience」に以下のように簡潔に説明されています。

Now, when you automatically generate notes for a release, we’ll identify all of the pull requests that are part of that release and create a summary for you, as well as recognize first-time contributors to your project.

リリースノートを自動的に作成する際には、そのリリースに含まれるすべてのプルリクエストを識別し、要約を作成します。と同時に、そのプロジェクトへの初めてのコントリビュータも認識します。

リリースノートの形式は、テンプレートとなる「.github\/release.yml」ファイルをカスタマイズすることで、リリースノート内のカテゴリタイトル（小見出し）と、そこにどのようなプルリクエストを含めるかなどを定義することができます。

自動生成されるリリースノートはプレビューで内容を確認後、そのまま公開することも、ドラフトとして保存し、書き換えた後に公開することもできるようになっています。