ワークフローステータスバッジを追加する

ステータスバッジは、ワークフローが現在失敗しているかパスしているかを示します。 ステータスバッジを追加する一般的な場所は、リポジトリのREADME.mdファイル中ですが、任意の好きなWebページに追加できます。 デフォルトでは、バッジはデフォルトブランチのステータスを示します。 特定のブランチやイベントに対するワークフローの実行のステータスを、URL中のbranch及びeventクエリパラメータを使って表示することもできます。

ワークフローファイルの名前でワークフローを参照します。

https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg

ワークフローファイル名を使用する

この Markdown の例では、.github/workflow/main.ymlというファイル パスのワークフローにステータス バッジを追加します 。 リポジトリの OWNER は github Organization で、REPOSITORY 名は docs です。

![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)

branch パラメータを使用する

この Markdown の例では、feature-1という名前のブランチにステータス バッジを追加します。

![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1)

event パラメータを使用する

この Markdown の例では、 pull_request イベントによってトリガーされたワークフロー実行のステータスを示すバッジを追加します。

![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=pull_request)