Examine Workflow badges

  • 3 minutes

Badges can be used to show the status of a workflow within a repository.

They show if a workflow is currently passing or failing. While they can appear in several locations, they typically get added to the README.md file for the repository.

Badges are added by using URLs. The URLs are formed as follows:

https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW\_FILE>/badge.svg

Where:

  • OWNER is the account name.
  • REPOSITORY is the repository name.
  • WORKFLOW is the workflow name.

Screenshot of the Badge failing in a color to represent an error.

They usually indicate the status of the default branch but can be branch-specific. You do this by adding a URL query parameter:

?branch=BRANCH

where:

  • BRANCH is the branch name.

For more information, see: Adding a workflow status badge.