How to Add a shields.io Build Status Badge

shields.io wraps the GitHub Actions workflow status in a themeable badge you can restyle with query parameters.

Use the github/actions/workflow/status shields.io route to render your workflow result with a custom label, logo, and style. It reads the same underlying status as the native badge.

Steps

Pick the route img.shields.io/github/actions/workflow/status/<owner>/<repo>/<workflow-file>.
Add ?branch=, ?label=, ?logo=, or ?style= to customize.
Link it to your Actions tab in the README.

README markdown

README.md

[![Build](https://img.shields.io/github/actions/workflow/status/acme/widget/ci.yml?branch=main&logo=github&label=build&style=flat-square)](https://github.com/acme/widget/actions/workflows/ci.yml)

Gotchas

shields.io caches results, so a fresh run may take a minute to appear.
The workflow file name is the last path segment; do not include .github/workflows/.

Related guides

How to Add a GitHub Actions Workflow Status BadgeAdd a GitHub Actions workflow status badge to your README by linking the built-in badge.svg endpoint for a sp… How to Add shields.io Coverage, Version, License, and Downloads BadgesAdd shields.io badges for coverage, package version, license, and downloads using the codecov, npm, and licen… How to Handle Badge Caching and the Camo ProxyUnderstand how GitHub proxies README badges through its camo image cache, why badges look stale, and how cach…