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