python / python/docsbuild-scripts

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

Offen
#170 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
86
Forks
69
Ø Merge
8 Std. 23 Min.
Gemergte PRs (30 T.)
5

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, check_versions.py zu lesen und auszuführen, um die Ausgabe seiner Versionstabelle zu verstehen, und überprüfe anschließend im README die Stelle für den Workflow-Link. Füge einen regelmäßig ausgeführten GitHub Actions-Workflow hinzu, der die Ausgabe des Skripts als job summary bereitstellt, und verlinke den Workflow im README; die Aufgabe ist erledigt, wenn die Zusammenfassung in einem workflow run sichtbar ist und aktuell bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github-actions, python
Bereich
ci-cd, documentation
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.