Skip to content

GitHub Workflows Badge

You can display a status badge in your repository to indicate the status of your workflows.

ref-official-doc

Parameters

Click to show/close parameters

NameTypeRequiredDefaultDescriptionMore Description
ref-params
ownerstringtrueGithub username
repostringtrueRepository name
workflowFilestringtrueWorkflow file name
ref-querys
branchstringBranch name
eventstringWorkflow trigger event name
txt
https://github.com/github/{owner}/{repo}/workflows/{workflowFile}/badge.svg{?branch,event}

Examples

markdown
<!-- xiaohuohumax/badge-collection -->
![Workflow Status](https://github.com/xiaohuohumax/badge-collection/actions/workflows/build-readme.yaml/badge.svg)
Workflow Status

Badge Collection (v3.0.5) MIT Licensed