ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

ワークフローの実行の管理

ワークフローの各ステップのステータスと結果を表示する、保留中のワークフローをキャンセルする、失敗したワークフローをデバッグして再実行する、ログを検索してダウンロードする、アーチファクトをダウンロードするなどが可能です。

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. 詳細は「GitHub の製品」を参照してください。

ここには以下の内容があります:

About workflow permissions

Anyone with read access for a GitHub Actions-enabled repository can see all information about a workflow. Read access allows you to download artifacts and view workflow files, run history, and logs.

You must have at least write-level access to cancel or re-run workflow runs.

詳細は「GitHub 上のアクセス権限」を参照してください。

ワークフロー管理について

ワークフローの実行ページから、ワークフローの実行が進行中か完了しているかを確認できます。 実行が進行中の場合はキャンセルできます。 実行が完了している場合には、結果が成功か失敗か、キャンセルされたか、またはニュートラルかを確認できます。 実行が失敗した場合には、ビルドログを表示して検索し、失敗の原因を診断してワークフローを再実行することもできます。 ログとビルドアーチファクトをダウンロードすることも可能です。

アノテーションされたワークフローの実行イメージ

GitHub Actionsは、Checks APIを使用してワークフローのステータス、結果、ログを出力します。 GitHub は、ワークフローの実行に対してそれぞれ新しいチェックスイートを作成します。 チェックスイートには、ワークフロー内の各ジョブに対するチェック実行が含まれ、各ジョブにはステップが含まれています。 GitHub Actionsは、ワークフローのステップとして実行されます。 Checks APIに関する詳しい情報については、GitHub 開発者ドキュメンテーションで「Checks」を参照してください。

ワークフロー履歴を表示する

ワークフローの実行の各ジョブと、ジョブの各ステップを表示することができます。 詳細については、「GitHub Actionsについて」を参照してください。

各ジョブにはデフォルトで [Set up Job] ステップと [Complete job] ステップがあり、ワークフローでアクションが設定されます。

  1. GitHub で、リポジトリのメインページへ移動します。

  2. リポジトリ名の下で [Actions] をクリックします。

    メインリポジトリナビゲーション内の Actions タブ

  3. 左のサイドバーで、表示するワークフローをクリックします。

    左サイドバーのワークフローリスト

  4. [Workflow runs] で、表示する実行の名前をクリックします。

    ワークフロー実行の名前

  5. Optionally, if the run failed, to re-run the workflow, in the upper-right corner of the workflow, use the Re-run checks drop-down menu, and select Re-run all checks.

    [Re-run checks] ドロップダウンメニュー

ワークフローの実行をキャンセルする

ワークフローの実行をキャンセルすると、GitHubはそのワークフローに含まれるすべてのステップをキャンセルします。

  1. GitHub で、リポジトリのメインページへ移動します。

  2. リポジトリ名の下で [Actions] をクリックします。

    メインリポジトリナビゲーション内の Actions タブ

  3. 左のサイドバーで、表示するワークフローをクリックします。

    左サイドバーのワークフローリスト

  4. [Workflow runs] で、表示する実行の名前をクリックします。

    ワークフロー実行の名前

  5. ワークフローの右上隅で、[Cancel check suite] をクリックします。

    [Cancel check suite] ボタン

ログを表示してエラーを診断する

ワークフローの実行を失敗した場合には、どのステップが失敗の原因になったかを確認し、失敗したステップのビルドログを確かめてトラブルシューティングすることができます。 各ステップの実行にかかった時間もわかります。 ログファイルの特定の行のパーマリンクをコピーして、チームで共有することもできます。

GitHubには完全なビルドログとアーチファクトが補完されますが、その期間はプッシュで90日間、プルリクエストで30日間です。 プルリクエストの場合の保持期間は、そのプルリクエストに対してプッシュがあるたびにリセットされます。

  1. GitHub で、リポジトリのメインページへ移動します。

  2. リポジトリ名の下で [Actions] をクリックします。

    メインリポジトリナビゲーション内の Actions タブ

  3. 左のサイドバーで、表示するワークフローをクリックします。

    左サイドバーのワークフローリスト

  4. [Workflow runs] で、表示する実行の名前をクリックします。

    ワークフロー実行の名前

  5. 左のサイドバーで、表示するジョブをクリックします。

    左サイドバーのジョブリスト

  6. ログを展開して、失敗したステップを確認するには、ステップをクリックします。

    失敗したステップの名前

  7. Optionally, to get a link to a specific line in the logs, click on the step's line number. You can copy the link from the address bar of your web browser.

    リンクをコピーするボタン

ログを検索する

特定のステップのビルドログを検索できます。 ログを検索する際、展開されているステップのみが結果に含まれます。

  1. GitHub で、リポジトリのメインページへ移動します。

  2. リポジトリ名の下で [Actions] をクリックします。

    メインリポジトリナビゲーション内の Actions タブ

  3. 左のサイドバーで、表示するワークフローをクリックします。

    左サイドバーのワークフローリスト

  4. [Workflow runs] で、表示する実行の名前をクリックします。

    ワークフロー実行の名前

  5. 左のサイドバーで、表示するジョブをクリックします。

    左サイドバーのジョブリスト

  6. 検索に含めたい各ステップを展開するには、そのステップをクリックします。

    ステップの名前

  7. ログ出力の右上隅にある [Search logs] 検索ボックスに、検索語句を入力します。

    ログを検索するための検索ボックス

ログとアーチファクトをダウンロードする

アーチファクトとは、コードをビルドしてテストするときに作成されるファイルのことです。 たとえば、アーティファクトには、バイナリまたパッケージファイル、テスト結果、スクリーンショット、ログファイルなどがあります。 実行が完了すると、これらのファイルはワークフローを実行した仮想環境から削除され、アーカイブされてダウンロードできるようになります。

  1. GitHub で、リポジトリのメインページへ移動します。

  2. リポジトリ名の下で [Actions] をクリックします。

    メインリポジトリナビゲーション内の Actions タブ

  3. 左のサイドバーで、表示するワークフローをクリックします。

    左サイドバーのワークフローリスト

  4. [Workflow runs] で、表示する実行の名前をクリックします。

    ワークフロー実行の名前

  5. ログをダウンロードするには、[Download logs] ドロップダウンメニューから、ダウンロードしたいログを選択します。

    [Download logs] ドロップダウンメニュー

  6. アーチファクトをダウンロードするには、[Artifacts] ドロップダウンメニューを使用して、ダウンロードしたいアーチファクトを選択します。

    [Artifacts] ドロップダウンメニュー

Enabling debug logging

If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging.

These extra logs are controlled by setting secrets in the repository containing the workflow. For more information on setting secrets, see "Creating and using secrets (encrypted variables)."

Enabling runner diagnostic logging

Runner diagnostic logging provides additional log files that contain information about how a runner is executing an action. 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 and artifacts."

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".

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください