python / python/docsbuild-scripts
Track output of `check_versions.py` in a GitHub Actions workflow's job summary
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 86
- 派生
- 69
- 平均合并
- 8 小时 23 分钟
- 30 天内合并 PR
- 5
描述
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?).
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
先阅读并运行 check_versions.py,以了解其版本表输出,然后查看 README 中 workflow 链接的位置。添加一个定期运行的 GitHub Actions workflow,将脚本输出作为 job summary 展示,并在 README 中添加指向该 workflow 的链接;当 summary 可从一次 workflow run 中查看且保持最新时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github-actions, python
- 领域
- ci-cd, documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100