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
クエリパラメータを使って表示することもできます。
ワークフローが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
です。

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

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

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