github · GitHub Actions Docs
Actions Adding a workflow status badge - GitHub Docs
Instructions for generating and embedding Markdown syntax to display the real-time execution status of a GitHub Actions workflow in a README or other documentation files.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Actions Adding a workflow status badge - GitHub Docs
Instructions for generating and embedding Markdown syntax to display the real-time execution status of a GitHub Actions workflow in a README or other documentation files.
When To Use
Use when you need to visually communicate the success or failure status of a CI/CD pipeline within a repository's documentation.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/actions-how-tos-monitor-workflows-adding-a-workflow-status-badge-github-workflow-guide.md | A guide explaining how to add a workflow status badge to a repository using the GitHub UI or by manually configuring the workflow file name and branch parameters. | Questions about a guide explaining how to add a workflow status badge to a repository using the GitHub UI or by manually configuring... |
examples/actions-how-tos-monitor-workflows-adding-a-workflow-status-badge-github-.text | A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge using a URL template. | Exact payloads, commands, or snippets shown in A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge using a URL template. |
examples/actions-how-tos-monitor-workflows-adding-a-workflow-status-badge-github--2.text | A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge into a README or documentation file. | Exact payloads, commands, or snippets shown in A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge into a README or doc... |
examples/actions-how-tos-monitor-workflows-adding-a-workflow-status-badge-github--3.text | A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge with a specific branch parameter. | Exact payloads, commands, or snippets shown in A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge with a specific bran... |
examples/actions-how-tos-monitor-workflows-adding-a-workflow-status-badge-github--4.text | A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge using a URL with an event parameter. | Exact payloads, commands, or snippets shown in A markdown snippet demonstrating the syntax for embedding a GitHub Actions workflow status badge using a URL with an... |
What This Skill Covers
-
- GitHub Actions / - How-tos / - Monitor workflows / - Add a status badge
- Main sections:
In this article,Using the UI,Using the workflow file name,Using the branch parameter,Using the event parameter.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://docs.github.com/en/actions/how-tos/monitor-workflows/add-a-status-badge