GitHub Actions の job summary とは？

job summary はステップが特別なファイルに書き込む Markdown で、GitHub が実行ページにレンダリングして一目で結果がわかるようにします。

ログはノイズが多いものです。job summary を使うと、ステップがテストの表やカバレッジの数値といったきれいな Markdown レポートを実行のページに直接公開でき、レビュアーは出力をスクロールせずに結果を見られます。

それは何か

job summary は GITHUB_STEP_SUMMARY 環境変数に格納されたファイル path に追記されるコンテンツです。GitHub はそれを workflow run ページに Markdown としてレンダリングします。

steps:
  - run: |
      echo "## Test results" >> "${GITHUB_STEP_SUMMARY}"
      echo "- Passed: 42" >> "${GITHUB_STEP_SUMMARY}"

どう動くか

どのステップも GITHUB_STEP_SUMMARY ファイルに Markdown を追記できます。GitHub はそれらをジョブごとに集めてまとめて表示し、表、リスト、画像などをサポートします。

一般的な用途

• テストの合否の表とカバレッジの数値。
• deployment の URL とバージョン番号。
• artifact や外部ダッシュボードへのリンク。

なぜ重要か

summary は生のログを読みやすいレポートに変え、レビューとトリアージを加速します。レビュアーが本当に気にする 1 つの数値を表示する最もきれいな方法です。

関連する概念

job summary は GITHUB_ENV と同じように特別なファイルを使い、実行結果を共有する artifact を補完します。

重要なポイント

• job summary は GITHUB_STEP_SUMMARY に書き込む Markdown です。
• 実行ページにレンダリングされ一目で結果がわかります。
• 表、リスト、リンク、画像をサポートします。

関連ガイド