「GitHub Actions」に「ジョブサマリー」機能追加、実行サマリーページにカスタムMarkdownコンテンツを出力可能に：テーブルのテストレポート、「Mermaid」の作図も表現できる

GitHubは「GitHub Actions」にジョブサマリー機能を導入し、各ジョブによって生成される実行サマリーにカスタムMarkdownコンテンツを出力できるようにした。

[＠IT]

　GitHubは2022年5月9日（米国時間）、「GitHub Actions」でジョブサマリー機能が利用可能になり、各ジョブによって生成される実行サマリーにカスタムMarkdownコンテンツを出力できるようになったと発表した。

　カスタムMarkdownコンテンツは、テスト結果の集計と表示、レポートの作成、ログに依存しないカスタム出力など、さまざまな創造的な目的に使用できるという。

サマリーの作成

　ジョブサマリーを作成するには、Markdownコンテンツを「$GITHUB_STEP_SUMMARY」という新しく導入された環境変数に出力すればよい。このファイルに追加されたMarkdownコンテンツは、Actionsの実行サマリーページに表示される。

steps:
  - name: Adding markdown
    run: echo '### Hello world! :rocket:' >> $GITHUB_STEP_SUMMARY

Markdownコンテンツの出力例（提供：GitHub）

　ジョブサマリーを追加する操作は、「$GITHUB_ENV」変数を使用して環境変数を定義する方法とよく似ている。

　GitHubは、アクション作成者がジョブサマリーを簡単に生成できるように、npmパッケージ「@actions/core」にも新しいヘルパーユーティリティーを追加した。

import * as core from '@actions/core' 
  await core.summary
  .addHeading('Test Results')
  .addCodeBlock(generateTestResults(), "js")
  .addTable([
    [{data: 'File', header: true}, {data: 'Result', header: true}],
    ['foo.js', 'Pass '],
    ['bar.js', 'Fail '],
    ['test.js', 'Pass ']
  ])
  .addLink('View staging deployment!', 'https://github.com')
  .write()

　アクション作成者はこの新しいユーティリティーによって、Markdownの個々の行またはブロックを簡単に追加できる。

　またGitHubは、テーブルも簡単に生成できるようにした。これもよく行われる操作だと想定したからだ。

新機能が追加された背景