Skip to main content

Adding a workflow status badge

You can display a status badge in your repository to indicate the status of your workflows.

A status badge shows whether a workflow is currently failing or passing. A common place to add a status badge is in the file of your repository, but you can add it to any web page you'd like. By default, badges display the status of your default branch. You can also display the status of a workflow run for a specific branch or event using the branch and event query parameters in the URL.

example status badge

You reference the workflow by the name of your workflow file.

![example workflow](<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg)

Using the workflow file name

This Markdown example adds a status badge for a workflow with the file path .github/workflows/main.yml. The OWNER of the repository is the github organization and the REPOSITORY name is docs.

![example workflow](

Using the branch parameter

This Markdown example adds a status badge for a branch with the name feature-1.

![example branch parameter](

Using the event parameter

This Markdown example adds a badge that displays the status of workflow runs triggered by the push event, which will show the status of the build for the current state of that branch.

![example event parameter](