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

2021年10月8日

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

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

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

fig リリースページの例

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

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

fig

どのようにリリースノートを自動作成するかは、「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」ファイルをカスタマイズすることで、リリースノート内のカテゴリタイトル(小見出し)と、そこにどのようなプルリクエストを含めるかなどを定義することができます。

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

このエントリーをはてなブックマークに追加
follow us in feedly




カテゴリ

Blogger in Chief

photo of jniino

Junichi Niino(jniino)
IT系の雑誌編集者、オンラインメディア発行人を経て独立。2009年にPublickeyを開始しました。
詳しいプロフィール

Publickeyの新着情報をチェックしませんか?
Twitterで : @Publickey
Facebookで : Publickeyのページ
RSSリーダーで : Feed


最新記事10本