python / python/docsbuild-scripts
Track output of `check_versions.py` in a GitHub Actions workflow's job summary
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 86
- Forks
- 69
- Merge medio
- 8 h 23 min
- PR fusionados (30 d)
- 5
Descripción
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?).
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza leyendo y ejecutando check_versions.py para entender la salida de su tabla de versiones; después, revisa en el README la ubicación del enlace al workflow. Añade un workflow de GitHub Actions que se ejecute periódicamente y exponga la salida del script como job summary, y enlaza al workflow desde el README; el trabajo estará terminado cuando el resumen sea visible desde un workflow run y se mantenga actualizado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- github-actions, python
- Área
- ci-cd, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100