python / python/docsbuild-scripts
Track output of `check_versions.py` in a GitHub Actions workflow's job summary
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 86
- Fork
- 69
- Merge medio
- 8h 23m
- PR unite (30g)
- 5
Descrizione
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".
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?).
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo ed eseguendo check_versions.py per comprendere l'output della relativa tabella delle versioni, quindi esamina nel README la posizione del link al workflow. Aggiungi un workflow GitHub Actions eseguito regolarmente che esponga l'output dello script come job summary e inserisci nel README un link al workflow; il lavoro è completato quando il riepilogo è visibile da un workflow run e rimane aggiornato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github-actions, python
- Ambito
- ci-cd, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100