Remarque : les badges de workflow dans un dépôt privé ne sont pas accessibles en externe. Vous ne pouvez donc pas les incorporer ni les lier à partir d’un site externe.
Un badge d’état indique si un workflow est en train d’échouer ou de réussir. En règle générale, vous ajoutez un badge d’état dans le fichier README.md de votre dépôt, mais vous pouvez l’ajouter dans n’importe quelle page web de votre choix. Par défaut, les badges affichent l’état de votre branche par défaut. Vous pouvez également afficher l’état d’une exécution de workflow pour une branche ou un événement spécifique en utilisant les paramètres de requête branch et event dans l’URL.
Pour ajouter un badge d’état de workflow à votre fichier README.md, recherchez d’abord l’URL du badge d’état que vous souhaitez afficher. Vous pouvez ensuite utiliser Markdown pour afficher le badge en tant qu’image dans votre fichier README.md. Pour plus d’informations sur le balisage d’image dans Markdown, consultez « Syntaxe de base pour l'écriture et la mise en forme ».
Utilisation du nom de fichier de workflow
Vous pouvez générer l’URL d’un badge d’état de workflow à l’aide du nom du fichier de workflow :
https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
Pour afficher le badge d’état du workflow dans votre fichier README.md, utilisez le balisage Markdown afin d’incorporer des images. Pour plus d’informations sur le balisage d’image dans Markdown, consultez « Syntaxe de base pour l'écriture et la mise en forme ».
Ajoutez par exemple la balise Markdown suivante à votre fichier README.md pour ajouter un badge d’état pour un workflow avec le chemin de fichier .github/workflows/main.yml. Le OWNER du dépôt est l’organisation github et le nom du REPOSITORY est docs.
Utilisation du paramètre branch
Pour afficher l’état d’exécution du workflow pour une branche spécifique, ajoutez ?branch=BRANCH-NAME à la fin de l’URL du badge d’état.
Ajoutez par exemple la balise Markdown suivante à votre fichier README.md pour afficher un badge d’état pour une branche nommée feature-1.
Utilisation du paramètre event
Pour afficher l’état des exécutions de workflow déclenchées par l’événement push, ajoutez ?event=push à la fin de l’URL du badge d’état.
Ajoutez par exemple le balisage Markdown suivant à votre fichier README.md pour afficher un badge avec l’état des exécutions de workflow déclenchées par l’événement push, qui affiche l’état de la build pour l’état actuel de cette branche.
