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

Track output of check_versions.py in a GitHub Actions workflow's job summary #170

Open
pradyunsg opened this issue Oct 7, 2023 · 1 comment

Comments

@pradyunsg
Copy link
Member

pradyunsg commented Oct 7, 2023

What would change?

Add a GitHub Actions workflow that regularly runs check_versions.py, and use the "job summary" feature to make that visible in a more prominent location. This would allow linking to the workflow's page from the README, where the user can click into one of the jobs and see the version table as a "job summary".

https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

The link from the README would be similar to this one for pypi-package.yml, and the job summary would be a markdown block presented like Build & verify package summary (this example uses <details> for dropdowns, and also attaches artifacts which are shown above the summary -- we likely wouldn't do either of those things).

What is the benefit of this?

This would eliminate the need for follow up bump PRs like #156 in the future, since the information would be automatically tracked and kept up to date via the regular re-runs of the script (with historical information as well, which is a nice side-effect?).

@hugovk
Copy link
Member

hugovk commented Oct 7, 2023

Sounds good.

I was about to open a PR with a make command that uses cog to update the README.

But more automation is good.

Perhaps we could combine this make+cog with GHA to update a Git file? Maybe like https://pyreadiness.org/ <- https://github.com/di/pyreadiness/blob/master/.github/workflows/cron.yml

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

No branches or pull requests

2 participants