Job Summaryとは？
job summaryは、CIのjobが出力し、workflow runのページにレンダリングされるカスタムMarkdownのブロックです。GitHub Actionsでは、stepがGITHUB_STEP_SUMMARYのファイルに内容を追記し、プラットフォームがそれを生ログの上に表示します。これにより、jobはコンソール出力のスクロールではなく、読みやすいレポートになります。
なぜ重要か
ログは直線的でノイズが多いですが、summaryを使えば、jobはテスト件数、カバレッジのテーブル、artifactへのリンクを、レビュアーが実際に見る場所に提示できます。これは失敗したrunを理解するまでの時間を短縮し、そうでなければ多数のログストリームを生むmatrix jobで特に役立ちます。
関連する概念
- GITHUB_STEP_SUMMARYにMarkdownを追記して書く
- 機械的な値を渡すstep outputとは別物
- 特定の行を示すannotationを補完する
関連ガイド
What Is a Step Output?A step output is a named value one workflow step exports so later steps or jobs can read it, passing data thr…
What Is a Workflow Run?A workflow run is a single execution of a CI workflow triggered by an event, containing all the jobs and step…
What Is a Check Run?A check run is a single test or validation reported against a commit, with a status, conclusion, and optional…