Skip to content

MarkDown snippets for GitHub Actions status badges

Notifications You must be signed in to change notification settings

TomasHubelbauer/github-actions-badge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 

Repository files navigation

GitHub Actions Badge

Use this MarkDown snippet to add a GitHub Actions status badge to your repo's readme:

![](https://github.com/tomashubelbauer/${repo}/workflows/${name}/badge.svg)
![](https://github.com/tomashubelbauer/${repo}/workflows/.github/workflows/${name.yml}/badge.svg)

You can use GitHub to generate the badge for you. Go to your latest workflow run, click on the triple-dot menu and select Create status badge.

For more information about GitHub Actions workflows, see github-actions.

GitHub Pages Badge

This one is a little tricky, at the GitHub Pages pipeline is hidden and as such provides no control over its file name or workflow name (name in the YAML).

I found it using the Actions tab, finding the GitHub Pages workflow, using the triple-dot menu and its Create Status Badge item. That UI generates the correct URL regardless of the pipeline type.

![](https://github.com/tomashubelbauer/${repo}/actions/workflows/pages/pages-build-deployment/badge.svg)