jeroenknoops / action-badges

🛡⚡️ A README badge service for GitHub Actions

Action Badges

A README badge service for GitHub Actions

Usage

Get a status badge for all GitHub Action runs on the master branch of a repository:

![badge](https://action-badges.now.sh/JasonEtco/example-repo)

Specify an action with the action query parameter:

![badge](https://action-badges.now.sh/JasonEtco/example-repo?action=test)

Note: This service only works for public repositories! It cannot read the status of your private repos.

How it works

When the /:owner/:repo endpoint is requested, the app makes a request to the GitHub API to get the list of check suites created by the GitHub Actions app. It then calculates the status based on the sum conclusion of the check suites and responds with some SVG code (thanks to badgen).