GitHub Actions でステータスバッジを表示する

はじめに

GitHub Actions v2 でステータスバッジを表示する方法です。
意外と知らない方も多いようですがちゃんと表示できます。

ステータスバッジとは？

README.md でよく見るこういうやつです。¹

ステータスバッジの表示

基本的にはドキュメントの通りです。
ワークフローを設定する - GitHub ヘルプ
継続的インテグレーションについて - GitHub ヘルプ

README.md に以下のコードを埋め込むと表示できます。

![](https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_NAME>/badge.svg)

<WORKFLOW_NAME> には name に設定された名前（空白文字は %20 に置換）か、ファイル名を指定できます。

ブランチを指定

branch パラメーターを付けることで特定のブランチを指定することが出来ます。

![](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg?branch=feature-1)

イベントを指定

event パラメーターを付けることで特定のイベントを指定することが出来ます。

![](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg?event=pull_request)

おわりに

ブランチとイベントの指定は最近追加されたようです。

1. 画像は公式ドキュメントからお借りしました。 ↩