ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

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

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

GitHub ActionsはGitHub Free、GitHub Pro、GitHub FreeのOrganization、GitHub Team、GitHub Enterprise Cloud、GitHub Oneで利用できます。 GitHub Actionsは、レガシーのリポジトリごとのプランを使っているアカウントが所有しているプライベートリポジトリでは利用できません。 For more information, see "GitHub's products."

ここには以下の内容があります:

A status badge shows whether a workflow is currently failing or passing. ステータスバッジを追加する一般的な場所は、リポジトリのREADME.mdファイル中ですが、任意の好きなWebページに追加できます。 By default, badges display the status of your default branch. 特定のブランチやイベントに対するワークフローの実行のステータスを、URL中のbranch及びeventクエリパラメータを使って表示することもできます。

example status badge

ワークフローがname キーワードを使用する場合は、ワークフローを名前で参照する必要があります。 ワークフローの名前に空白が含まれている場合は、URL エンコード文字列の%20で空白を置き換えなければなりません。 name キーワードに関する詳しい情報については、「GitHub Actionsのためのワークフローの構文」を参照してください。

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

または、ワークフローに nameが含まれていない場合は、リポジトリのルート ディレクトリに対する相対ファイル パスを使用してワークフロー ファイルを参照する必要があります。

ノート: ワークフローに nameが含まれていない場合、ファイル パスを使用してワークフロー ファイルを参照するのは機能しません。

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

ワークフロー名を使用する

このMarkdownの例では、"Greet Everyone" という名前のワークフローにステータス バッジを追加します。 リポジトリの OWNER は、actionsというOrganizationであり、 REPOSITORYの名前はhello-worldです。

![example workflow name](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg)

ワークフローのファイルパスを使用する

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

![example workflow file path](https://github.com/actions/hello-world/workflows/.github/workflows/main.yml/badge.svg)

branch パラメータを使用する

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

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

event パラメータを使用する

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

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

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.