GitHub Actionsでワークフローのデバッグ

GitHub Actionsの実行結果を確認する

GitHubのWebUIで確認する

Actionsタブから実行結果を確認できる。
WebUIの画面で対象のワークフローを選択すると、過去の実行履歴が表示される。履歴を選択すると詳細を確認できる。

バッジで確認する

バッジで最終実行結果の状態を見ることができる。
Markdownが表示されるのでREADME.mdに貼っておけば、リポジトリのトップページで確認できる。

通常のログ

ワークフローのを選択すると詳細を確認できる。各ステップのログがそれぞれ表示され、ログの閲覧やダウンロードなどが可能。

生ログの閲覧。

ログのダウンロード。

GitHub Actionsのワークフローデバッグ

• Managing a workflow run

デバッグログを出力して実行の詳細を記録することができる。

Enabling debug logging

Runner diagnostic logging provides additional log files that contain information about how a runner is executing a job. Two extra log files are added to the log archive:

• The runner process log, which includes information about coordinating and setting up runners to execute jobs.
• The worker process log, which logs the execution of a job.

1. To enable runner diagnostic logging, set the following secret in the repository that contains the workflow: ACTIONS_RUNNER_DEBUG to true.
2. To download runner diagnostic logs, download the log archive of the workflow run. The runner diagnostic logs are contained in the runner-diagnostic-logs folder. For more information on downloading logs, see “Downloading logs.”

1. secretでACTIONS_RUNNER_DEBUGをtrueで設定する。
2. 作成されたログはダウンロードしたZIPファイル内のrunner-diagnostic-logsにある。

runner-diagnostic-logs内にはBuild UnknownBuildNumber-<リポジトリ名>.zipのアーカイブがあり、以下のファイルがある。

1
2
3
4
5

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----       2020/05/19     17:07          11424 Runner_20200519-170525-utc.log
-a----       2020/05/19     17:05           1338 Worker_20200519-170519-utc.log
-a----       2020/05/19     17:07          61565 Worker_20200519-170530-utc.log

Enabling step debug logging

Step debug logging increases the verbosity of a job’s logs during and after a job’s execution.

1. To enable step debug logging, you must set the following secret in the repository that contains the workflow: ACTIONS_STEP_DEBUG to true.
2. After setting the secret, more debug events are shown in the step logs. For more information, see “Viewing logs to diagnose failures”.

1. secretでACTIONS_STEP_DEBUGをtrueで設定する。
2. 設定後ステップログでデバッグイベントが出力される。

ログに[debug]の付いた行が追加されている。画面上ではパープルでハイライトされ、より詳細なステップログになっている。

1
2
3
4
5
6
7
8
9
10
11
12
13

##[debug]Starting: Complete job
Uploading runner diagnostic logs
##[debug]Starting diagnostic file upload.
##[debug]Setting up diagnostic log folders.
##[debug]Creating diagnostic log files folder.
##[debug]Copying 2 worker diagnostic logs.
##[debug]Copying 1 runner diagnostic logs.
##[debug]Zipping diagnostic files.
##[debug]Uploading diagnostic metadata file.
##[debug]Diagnostic file upload complete.
Completed runner diagnostic log upload
Cleaning up orphan processes
##[debug]Finishing: Complete job