Skip to main content
A workflow status badge provides real-time visibility into your CI/CD pipeline directly from your README or any Markdown page. This guide walks you through generating and embedding badges for one or multiple GitHub Actions workflows.

​
1. Generate the Badge Markdown

  1. Navigate to your repository on GitHub and click the Actions tab.
  2. Select the workflow you want to badge (e.g., vault-demo).
  3. In the workflow overview, click Create status badge.
The image shows a GitHub interface with a pop-up window for creating a status badge, allowing the user to select a branch and copy the badge's Markdown code.
By default, GitHub uses your default branch (often main). You can switch branches or filter by event types before copying the badge snippet.

​
2. Embed the Badge in Markdown

Copy the Markdown snippet provided by GitHub and paste it into your README.md (or any .md file): 
[![Vault Demo](https://github.com/sidd-harth-7/actions-1/actions/workflows/vault-demo.yml/badge.svg)](https://github.com/sidd-harth-7/actions-1/actions/workflows/vault-demo.yml)
ParameterExamplePurpose
Workflow nameVault DemoThe label displayed alongside the badge
SVG URLhttps://github.com/…/vault-demo.yml/badge.svgRenders the badge image
Link URLhttps://github.com/…/vault-demo.ymlDirects to the workflow runs page
Save and commit your changes. The badge will update automatically to reflect the latest workflow status.

​
3. Track Multiple Workflows

To monitor additional workflows, repeat Step 1 and Step 2 for each workflow. For example:
The image shows a GitHub Actions page for a repository, displaying a list of workflow runs with their statuses, including a manually disabled workflow.
Each workflow adds its own badge, allowing you to display an overview of all your pipelines at a glance.
If you’re updating only your README, consider adding [skip ci] to your commit message to avoid triggering CI workflows unnecessarily.

​
Additional Resources

Watch Video