Note: GitHub-hosted runners are not currently supported on GitHub Enterprise Server. You can see more information about planned future support on the GitHub public roadmap.
A status badge shows whether a workflow is currently failing or passing. A common place to add a status badge is in the README.md
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.
You reference the workflow by the name of your workflow file.
![example workflow](<HOSTNAME>/<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](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
Using the branch
parameter
This Markdown example adds a status badge for a branch with the name feature-1
.
![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1)
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](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)