Badge request: GitHub actions

[xiaoxiangmoe]

📋 Description

badges for github actions

🔗 Data

Being consulted, this is just an idea. No API available now.

https://developer.github.com/actions/

[paulmelnikow]

Some questions for you:

1. What's the problem you're wanting to solve?
2. How do you want to use github actions to solve it?
3. How would the badge be part of that?

[xiaoxiangmoe]

• Q: What's the problem you're wanting to solve?
  A: Badge for unit test status and coverages in github actions.
• Q: How do you want to use github actions to solve it?
  A: I'll use github actions as runner for testing.
• Q: How would the badge be part of that?
  A: Badge will show result of testing.

[devblackops]

Here is an example: https://github.com/CultureHQ/github-actions-badge

[dougnukem]

@devblackops I'm using the badge from @kddeisz and it works great, they added functionality to link to github action results as well, maybe that can be added to shields.io (right now its a Lambda JS function).

• https://github.com/cedrickring/golang-action/blob/6fb2e21b8a312a444d7ce88ebb93783739d82f8f/README.md

[gr2m]

See also https://github.com/JasonEtco/action-badges @JasonEtco

[smorimoto]

+1

[chris48s]

It looks like the other example posted is calling a URL like https://api.github.com/repos/badges/shields/commits/master/check-suites with the header Accept: application/vnd.github.antiope-preview+json, e.g:

curl -H "Accept: application/vnd.github.antiope-preview+json" https://api.github.com/repos/badges/shields/commits/master/check-suites

..and then looking for a check-suite with the name "GitHub Actions". GitHub's docs on this API call say

The API may change without advance notice during the preview period. Preview features are not supported for production use

( see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref )

but tbh, if someone's interested in working on this, I'd be inclined to take a PR for it even though the API is beta at this stage.

[qoomon]

FYI official badge api https://github.com/{github_id}/{repository}/workflows/{workflow_name}/badge.svg

[chris48s]

official badge api

How interesting..

https://github.com/actions/toolkit/workflows/Main%20workflow/badge.svg

Do you have a link to the docs for that, or do you have to be in the actions beta to see them? I'd be interested to read more about this.

[qoomon]

Found it at reddit -> https://www.reddit.com/r/github/comments/csehoc/github_actions_official_status_badges/

[calebcartwright]

I wonder if we went the SvgScraping route if we'd be able to avoid having to use tokens from the pool/hitting the throttling limits 🤔

[khakiout]

FYI official badge api https://github.com/{github_id}/{repository}/workflows/{workflow_name}/badge.svg

Based on my testing, the workflow should be on the main branch for the badge to be generated. How about you?

[calebcartwright]

@khakiout - I believe that is true based on what I've seen

[calebcartwright]

I've opened #3898 and #3913 with two different implementations we could consider using. However, my takeaway from working on these is that any support we may potentially add for GitHub Actions to Shields in the short term would inevitably have some limitations and wouldn't be able to support certain edge cases.

At this moment GH Actions are still pretty new/beta, and there's just not a good official/well documented approach for Shields to get the GH Actions data, so we're stuck using the undocumented/unofficial or indirect approaches.

[calebcartwright]

Also if anyone is using GitHub Actions in your repos and is willing to test...

Try out your repo/workflow in the staging apps:

• https://shields-staging-pr-3898.herokuapp.com (named workflow, default branch only)
• https://shields-staging-pr-3913.herokuapp.com (by branch/ref)

[crazy-max]

@calebcartwright Works fine for me on WindowsSpyBlocker 👌

[vintagesucks]

@calebcartwright Works fine for me, too. 👍

[SerafimArts]

There are doubts that this functionality works as it should. At the moment, all the links on the badge.svg returns 404 for me.

Do you have exactly the same?

[knocte]

Do you have exactly the same?

It works for me, look at the CI badges in my project: https://github.com/knocte/geewallet

[SerafimArts]

@knocte Yes, it’s working now. Maybe it was just a temporary problem.

Thx 👍

[sunsheeppoplar]

Does anyone know whether or not this works on private repos?

[calebcartwright]

Hi Folks - just a friendly reminder that if you have questions about GitHub's native badge for GitHub Actions/Workflows, you should probably use a different channel to pose those questions. I'd suggest going to one of the GitHub forums to try to get an answer directly from GitHub.

This thread is getting really long, with a lot of non-Shields related comments. Would like to try keep this thread focused on the OT of Shields.io support for GH Actions badges.

Thanks!

[svoop]

Given the case-sensitive workflow names: It would be nice, if the actions badge implementation accepted an optional query parameter label= to override the name rendered on the badge. This way, you could have consistent badge labels (e.g. all lowercase) and still use different cases (or even names) for the workflows themselves.

(@calebcartwright BTW: When an issue gets OT comments like the ones above, you can hide them by clicking on the "Hide" in the ... menu next to each comment. Hidden comments are only collapsed, those interested can read them anyways.)

[calebcartwright]

It would be nice, if the actions badge implementation accepted an optional query parameter label= to override the name rendered on the badge

This is supported on all Shields badges, and will also be available for Shields badges for GH Actions

BTW: When an issue gets OT comments like the ones above, you can hide them by clicking on the "Hide" in the ... menu next to each comment. Hidden comments are only collapsed, those interested can read them anyways.

Thanks @svoop, I'm aware of this but deliberately left them as-is since they contain information folks may find useful outside the Shields context.

[svoop]

@calebcartwright Jeez, me, always one step behind 😄 Thanks for the hint!

[calebcartwright]

no worries!

[calebcartwright]

Closed via #3898

[calebcartwright]

This feature has been implemented is now live! Thanks to @paulmelnikow for getting it shipped so quickly after the PR was merged🎉

Some examples:
https://img.shields.io/github/workflow/status/apache/arrow/Python

And one with all sorts of Shields-customization goodness
https://img.shields.io/github/workflow/status/apache/arrow/Python?color=orange&label=actions&logo=github&logoColor=orange&style=for-the-badge

There's another issue open to track the work for implenting Job-level status badges in #4364 if anyone is interested in tracking that work (or implementing! ❤️)

[PyvesB]

Official Tweet about this new badge: https://twitter.com/Shields_io/status/1200540112368611328

Like and retweet to give us more visibility! 😉

[the-j0k3r]

I cant get this to work

https://github.com/bus-stop/x-terminal/workflows/main/badge.svg

Seems all valid and based on format shared?

[paulmelnikow]

Ah, the name is defined in the YML file; it doesn't come from the name of the YML file.

https://img.shields.io/github/workflow/status/bus-stop/x-terminal/CI
https://github.com/bus-stop/x-terminal/workflows/CI/badge.svg