ワークフロー状態バッジの追加

ステータスバッジは、ワークフローが現在失敗しているかパスしているかを示します。 ステータス バッジは、リポジトリの README.md ファイル内に追加するのが一般的ですが、どの Web ページにも追加することができます。 デフォルトでは、バッジはデフォルトブランチのステータスを示します。 既定のブランチでワークフローの実行がない場合は、すべてのブランチで最新の実行状態が表示されます。 特定のブランチやイベントのワークフロー実行のステータスを、URL 内の branch および event クエリ パラメーターを使用して表示することもできます。

ワークフロー状態バッジを README.md ファイルに追加するには、最初に表示したい状態バッジの URL を見つけます。 その後、Markdown を使って、README.md ファイル内に画像としてバッジを表示できます。 Markdown での画像のマークアップについては、「基本的な書き方とフォーマットの構文」を参照してください。

UI を使用する

ワークフロー ファイル名、ブランチ パラメーター、イベント パラメーターを使って、UI 上でワークフロー状態バッジを直接作成できます。

1. GitHub で、リポジトリのメイン ページに移動します。

2. リポジトリ名の下にある [アクション] をクリックします。

   

3. 左サイドバーで、表示するワークフローをクリックします。

   

4. ページの右側に [Filter workflow runs] フィールドがあり、その横にある をクリックしてドロップダウン メニューを表示し、[Create status badge] をクリックします。

5. 既定のブランチとは異なるブランチの状態バッジを表示する場合は、必要に応じてブランチを選びます。

6. 必要に応じて、ワークフローをトリガーするイベントを選びます。

7. [ Copy status badge Markdown] をクリックします。

8. Markdown を README.md ファイルにコピーします。

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

ワークフロー ファイルの名前を使用して、ワークフロー状態バッジの URL を作成できます。

https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg

README.md ファイル内にワークフロー状態バッジを表示するには、Markdown マークアップを使用して画像を埋め込みます。 Markdown での画像のマークアップについては、「基本的な書き方とフォーマットの構文」を参照してください。

たとえば、次の Markdown を README.md ファイルに追加して、ファイル パスが .github/workflows/main.yml であるワークフローの状態バッジを追加します。 リポジトリの OWNER は github Organization であり、REPOSITORY 名は docs です。

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

branch パラメーターの使用

特定のブランチに関するワークフロー実行の状態を表示するには、状態バッジ URL の末尾に ?branch=BRANCH-NAME を追加します。

たとえば、次の Markdown を README.md ファイルに追加して、feature-1 という名前のブランチの状態バッジを表示します。

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

event パラメーターの使用

push イベントによってトリガーされるワークフロー実行の状態を表示するには、状態バッジ URL の末尾に ?event=push を追加します。

たとえば、次の Markdown を README.md ファイルに追加して、push イベントによってトリガーされるワークフロー実行の状態を含むバッジを表示します。これにより、そのブランチの現在の状態に対してビルドの状態が表示されます。

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