Note: Workflow badges in a private repository are not accessible externally, so you won't be able to embed them or link to them from an external site.
Ein Statusbadge zeigt an, ob ein Workflow derzeit fehlerhaft oder korrekt ausgeführt wird. Ein gängiger Ort für ein Statusbadge ist die Datei README.md
deines Repositorys, du kannst den Badge aber zu jeder beliebigen Webseite hinzufügen. Standardmäßig zeigen Badges den Status deines Standardbranchs an. Du kannst auch den Status einer Workflowausführung für einen bestimmten Branch oder ein bestimmtes Ereignis anzeigen, indem du die Abfrageparameter branch
und event
in der URL verwendest.
To add a workflow status badge to your README.md
file, first find the URL for the status badge you would like to display. Then you can use Markdown to display the badge as an image in your README.md
file. For more information about image markup in Markdown, see "Grundlegende Schreib- und Formatierungssyntax."
Using the workflow file name
You can build the URL for a workflow status badge using the name of the workflow file:
https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
To display the workflow status badge in your README.md
file, use the Markdown markup for embedding images. For more information about image markup in Markdown, see "Grundlegende Schreib- und Formatierungssyntax."
For example, add the following Markdown to your README.md
file to add 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
To display the status of a workflow run for a specific branch, add ?branch=BRANCH-NAME
to the end of the status badge URL.
For example, add the following Markdown to your README.md
file to display 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
To display the status of workflow runs triggered by the push
event, add ?event=push
to the end of the status badge URL.
For example, add the following Markdown to your README.md
file to display a badge with the status of workflow runs triggered by the push
event, which will show the status of the build for the current state of that branch.
![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)