GitHub Actions のログを見やすくする

雑記

console.logprocess.stdout.write でログに出力できますが、特定のフォーマットで出力することでログが見やすくなります。

フォーマット

warning

警告メッセージを表示する際に使用します。

import { EOL } from 'os';

process.stdout.write('::warning::warning...' + EOL);

error

エラーメッセージを表示する際に使用します。

import { EOL } from 'os';

process.stdout.write('::error::error...' + EOL);

debug

デバッグメッセージを出力する際に使用します。

import { EOL } from 'os';

process.stdout.write('::debug::debug...' + EOL);

特に何もしていない場合は出力されません。

Secrets から ACTIONS_STEP_DEBUGtrue を設定することで出力されます。

group

ログ出力をグループ化できます。

グループを閉じる endgroup と共に使用します。

import { EOL } from 'os';

process.stdout.write('::group::Test' + EOL);
process.stdout.write('::debug::debug...' + EOL);
process.stdout.write('::error::error...' + EOL);
process.stdout.write('::warning::warning...' + EOL);
process.stdout.write('::endgroup::' + EOL);

ライブラリ

これらに機能を簡単に利用できる方法が用意されています。

actions/toolkit
The GitHub ToolKit for developing GitHub Actions. Contribute to actions/toolkit development by creating an account on GitHub.
const core = require('@actions/core');

core.startGroup('Test');
core.debug('debug...');
core.error('error...');
core.warning('warning...');
core.endGroup();

コメント

タイトルとURLをコピーしました