docsbuild-scripts icon indicating copy to clipboard operation
docsbuild-scripts copied to clipboard

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

Open pradyunsg opened this issue 2 years ago • 1 comments

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

pradyunsg avatar Oct 07 '23 19:10 pradyunsg

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

hugovk avatar Oct 07 '23 21:10 hugovk