python / python/docsbuild-scripts
Track output of `check_versions.py` in a GitHub Actions workflow's job summary
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 86
- フォーク
- 69
- 平均マージ
- 8時間 23分
- マージ済み PR(30日)
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず check_versions.py を読んで実行し、そのバージョンテーブルの出力を理解してから、README で workflow リンクの場所を確認します。スクリプトの出力を job summary として公開する、定期的に実行される GitHub Actions workflow を追加し、README から workflow にリンクします;workflow run から summary が確認でき、最新の状態が維持されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- github-actions, python
- 領域
- ci-cd, documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100