python / python/docsbuild-scripts

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

Open
#170 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
86
Forks
69
Avg merge
8h 23m
Merged PRs (30d)
5

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading and running check_versions.py to understand its version-table output, then review the README location for the workflow link. Add a regularly run GitHub Actions workflow that exposes the script's output as a job summary and link to the workflow from the README; done means the summary is visible from a workflow run and stays current.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.