Note
Workflowbadges in einem privaten Repository sind nicht extern zugänglich, sodass du sie nicht einbetten oder von einer externen Website aus verlinken kannst.
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. Wenn in Ihrem Standardbranch kein Workflow ausgeführt wird, wird der Status der letzten Ausführung über alle Branches hinweg angezeigt. Sie können den Status einer Workflowausführung für einen bestimmten Branch oder ein bestimmtes Ereignis anzeigen, indem Sie die Abfrageparameter branch und event in der URL verwenden.
Wenn du deiner README.md-Datei einen Workflowstatusbadge hinzufügen möchtest, suche zuerst die URL für den Statusbadge, den du anzeigen möchtest. Anschließend kannst du Markdown verwenden, um den Badge als Bild in deiner README.md-Datei anzuzeigen. Weitere Informationen zu Bildmarkup in Markdown findest du unter Grundlegende Schreib- und Formatierungssyntax.
Verwenden des Workflowdateinamens
Du kannst die URL für einen Workflowstatusbadge mithilfe des Namens der Workflowdatei erstellen:
https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
Um den Workflowstatusbadge in deiner README.md-Datei anzuzeigen, verwende das Markdownmarkup zum Einbetten von Bildern. Weitere Informationen zu Bildmarkup in Markdown findest du unter Grundlegende Schreib- und Formatierungssyntax.
Füge beispielsweise deiner README.md-Datei das folgende Markdownelement hinzu, um einen Statusbadge für einen Workflow mit dem Dateipfad .github/workflows/main.yml hinzuzufügen. Der OWNER des Repositorys ist die github-Organisation und der REPOSITORY-Name ist docs.
Verwenden des branch-Parameters
Zum Anzeigen des Status eines Workflows, der für einen bestimmten Branch ausgeführt wird, füge dem Ende der Statusbadge-URL ?branch=BRANCH-NAME hinzu.
Füge beispielsweise deiner README.md-Datei das folgende Markdownelement hinzu, um einen Statusbadge für einen Branch mit dem Namen feature-1 anzuzeigen.
Verwenden des event-Parameters
Zum Anzeigen des Status von Workflowausführungen, die vom push-Ereignis ausgelöst werden, füge dem Ende der Statusbadge-URL ?event=push hinzu.
Füge beispielsweise deiner README.md-Datei das folgende Markdownelement hinzu, um einen Badge mit dem Status von Workflowausführungen anzuzeigen, die vom push-Ereignis ausgelöst werden, wodurch der Status des Builds für den aktuellen Zustand des betreffenden Branchs angezeigt wird.
