jasonetco / action-badges

🛡⚡️ A README badge service for GitHub Actions

This project is deprecated! Badges are now officially part of the GitHub Actions platform!

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).

action-badges's Issues

Status badge shows "build: mixed" even though the workflow was successful

When I visit the URL for the badge for my public repo (https://action-badges.now.sh/xJREB/microservices-runtime-analysis), I see the correct "build: passing" badge. However, on Github in my README (https://github.com/xJREB/microservices-runtime-analysis), I see a different badge with "build: mixed". Any idea what is happening there? Did I inlcude the badge somehow wrongly?

[![Actions Status](https://action-badges.now.sh/xJREB/microservices-runtime-analysis)](https://github.com/xJREB/microservices-runtime-analysis/actions)

Flat design badge

It would be great if a flat design version is also available.

Add metrics tracking

There's currently zero tracking for activity. It'd be great to track things like number of requests made to the service in aggregate, just to get a better understanding of how many repos are actually using it.

Add branch selection

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

It would be great to add the ability to specify the branch to check, e.g. ?branch=foo, like with Travis/Circle CI badges.

Thanks you for a nice tool!

Support querying for a specific workflow

Discovered in #2, there's no way to identify which check suite related to a specific GitHub Actions workflow. I thought that's what the check_name parameter does, but that's actually the check run, which is an individual GitHub Action (an action block in a workflow).

This'd be really useful for projects that have multiple workflows, but only want to show the status of one of them - think a release workflow and a test workflow, the badge only needs to show the status of the latter.

Two options:

1. I'll ask around internally to see if there's a way to add the workflow name to the check suite object.
2. Query for the main.workflow file, parse it to get the workflow we care about and the actions it has, then find the check suite whose list of check runs matches the list of actions. This is... hacky, but might work.

More information

https://action-badges.now.sh/gr2m/twitter-together

It'd be interesting if it linked to builds:
https://github.com/nock/twitter/runs/76823945
https://github.com/probot/twitter/runs/82446300

or summarized with details like 2/2 failing

Enable for private repos?

What would it take to make this work for private repos? I'm not 100% sure how now.sh stores data on requests, but I know some badge services allow you to pass an api key, would it be possible for us to make that work here too?

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

Support review of last action result only

Url with this feature would see like {owner}/{repo}/?only_last=true