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

Check status badges #559

Open
jeroen opened this issue Jan 11, 2025 · 2 comments · May be fixed by r-universe-org/docs#84
Open

Check status badges #559

jeroen opened this issue Jan 11, 2025 · 2 comments · May be fixed by r-universe-org/docs#84
Assignees

Comments

@jeroen
Copy link
Member

jeroen commented Jan 11, 2025

Added a badge that tries to summarize the "check status" of the package, e.g:

https://ropensci.r-universe.dev/magick/badges/checks

badge

It is somewhat arbitrary which runs are taken in consideration when summarising results into a single "conclusion".

The current implementation includes status for building vignettes and check results for r-release and r-devel on win/mac/linux and then shows the "worst result" of those checks. So if there is 1 "error", 1 "warning and 5 ok, the badge shows "error".

It ignores r-oldrel and platforms where we only build binaries but do not check (webassembly), to avoid false positives.

We could also split out the badges: one with the check result on windows, one for macos, one for linux. Or by R release. But I am not sure how useful that would be.

@jeroen
Copy link
Member Author

jeroen commented Jan 12, 2025

@maelle if this looks good we can document the api.

@maelle maelle self-assigned this Jan 13, 2025
@maelle
Copy link
Collaborator

maelle commented Jan 13, 2025

To me the current API is good as is, because it matches my expectations of GHA status badges. I'll make a PR to the docs.

@maelle maelle linked a pull request Jan 13, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants