Skip to main content

このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2024-08-29. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

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

リポジトリにステータスバッジを表示して、ワークフローのステータスを示すことができます。

注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

: プライベート リポジトリ内のワークフロー バッジには外部からアクセスできないため、外部サイトからそれらを埋め込んだり、リンクしたりすることはできません。

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

ワークフローの状態バッジのスクリーンショット。 左側には、octocat のロゴと "GitHub Actions Demo" (ワークフローの名前) が含まれています。 右半分は緑色で、"passing" というテキストが表示されています。

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

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

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

HOSTNAME/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg

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

たとえば、次の Markdown を README.md ファイルに追加して、ファイル パスが .github/workflows/main.yml であるワークフローの状態バッジを追加します。 リポジトリの OWNERgithub 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)