1
0
mirror of synced 2026-01-29 12:00:58 -05:00
Files
docs/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md
2021-06-14 12:06:52 -07:00

1.5 KiB

title, intro, product, versions
title intro product versions
Adding a workflow status badge You can display a status badge in your repository to indicate the status of your workflows. {% data reusables.gated-features.actions %}
free-pro-team enterprise-server github-ae
* >=2.22 *

{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %}

{% data reusables.repositories.actions-workflow-status-badge-into %}

You reference the workflow by the name of your workflow file.

https://github.com/<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 pull_request event.

![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=pull_request)