Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create individual status badges for packages #87

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

epassaro
Copy link
Contributor

@epassaro epassaro commented Jun 3, 2022

This pull request will enable the automatic creation (and update) of status badges specific to every job (packages).

Some considerations:

  • Requires logging to JSONbin.org with the organization GitHub account
  • This workflow is scheduled to run an hour after the nightly tests start
  • The workflow can be run manually
  • Why not a push trigger? Because immediately after pushing changes to master the jobs will be marked as "pending". This could be fixed by using the previous commit SHA to create badges after push, but I think it's not necessary for a first implementation of the workflow
  • Badges are created through the shields.io endpoint by storing a JSON dictionary in JSONbin.org
  • Badges will be available at https://img.shields.io/endpoint?url=https://jsonbin.org/numba/numba-integration-testing/nightly/<package>/badge
  • After merging this PR, wait an hour and run the workflow manually. Otherwise, the status of the jobs are "pending" and will be ignored
  • IMPORTANT: scheduled workflows will be disabled in public repos with no activity for 60 consecutive days. That's GitHub policy, nothing I can do.

Example: https://github.com/epassaro/numba-integration-badges

Closes #86

@epassaro
Copy link
Contributor Author

epassaro commented Jun 3, 2022

This should work out of the box @esc, If there's any problem ping me.

@esc esc self-assigned this Jun 3, 2022
@esc
Copy link
Member

esc commented Jun 9, 2022

This should work out of the box @esc, If there's any problem ping me.

Thank you, this is now in my queue at: https://github.com/orgs/numba/projects/4/views/1

@esc
Copy link
Member

esc commented Aug 11, 2022

@epassaro apologies for the delay on this one. It became stuck, because we couldn't decide who should hold the credentials for JSONbin.org. Would it be possible to stuff the JSON elsewhere, e.g. a second DAG in a git repo?

@esc
Copy link
Member

esc commented Aug 11, 2022

@epassaro apologies for the delay on this one. It became stuck, because we couldn't decide who should hold the credentials for JSONbin.org. Would it be possible to stuff the JSON elsewhere, e.g. a second DAG in a git repo?

I think this is do-able, I created a mock-up here:

https://github.com/esc/numba-integration-testing/tree/badges-from-git

The question is how to get GHA to stuff the JSON data badges into the badges branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Selected for Review
Development

Successfully merging this pull request may close these issues.

Question: Best way to get a status badge for a job?
2 participants