python / python/docsbuild-scripts
Track output of `check_versions.py` in a GitHub Actions workflow's job summary
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 86
- Forks
- 69
- Merge médio
- 8h 23min
- PRs com merge (30d)
- 5
Descrição
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?).
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece lendo e executando check_versions.py para entender a saída da tabela de versões e, em seguida, revise no README o local do link para o workflow. Adicione um workflow do GitHub Actions executado regularmente que exponha a saída do script como job summary e vincule o workflow a partir do README; o trabalho estará concluído quando o resumo estiver visível a partir de um workflow run e permanecer atualizado.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- github-actions, python
- Domínio
- ci-cd, documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 42/100