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

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

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

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub One. GitHub Actionsは、レガシーのリポジトリごとのプランを使っているアカウントが所有しているパブリックあるいはプライベートリポジトリでは利用できません。 詳しい情報については「GitHubの製品」を参照してください。

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

ワークフローの権限について

GitHubにログインしており、ワークフローのリポジトリに読み取りアクセスを持っていれば、ワークフローに関するすべての情報を見ることができます。 読み取りアクセスがあれば、成果物のダウンロード、ワークフローファイルや実行履歴、ログの閲覧ができます。

ノート: パブリックリポジトリの場合であっても、ワークフローの実行情報を見るにはGitHubアカウントにログインしていなければなりません。

ワークフローの実行のキャンセルあるいは再実行には、最低でも書き込みレベルのアクセスを持っていなければなりません。

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

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

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

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

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

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

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

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

  1. GitHubで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下でActions(アクション)をクリックしてください。

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

  3. 左のサイドバーで、表示させたいワークフローをクリックしてください。

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

  4. "Workflow runs(ワークフローの実行)"の下で、表示させたい実行の名前をクリックしてください。

    ワークフローの実行の名前

  5. あるいは実行が失敗した場合にワークフローを再実行するには、ワークフローの右上隅で [Re-run checks] ドロップダウンメニューから [Re-run all checks] を選択します。

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

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

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

  1. GitHubで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下でActions(アクション)をクリックしてください。

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

  3. 左のサイドバーで、表示させたいワークフローをクリックしてください。

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

  4. "Workflow runs(ワークフローの実行)"の下で、表示させたい実行の名前をクリックしてください。

    ワークフローの実行の名前

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

    [Cancel check suite] ボタン

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

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

GitHub stores full build logs and artifacts for 90 days.

  1. GitHubで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下でActions(アクション)をクリックしてください。

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

  3. 左のサイドバーで、表示させたいワークフローをクリックしてください。

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

  4. "Workflow runs(ワークフローの実行)"の下で、表示させたい実行の名前をクリックしてください。

    ワークフローの実行の名前

  5. 左のサイドバーで、表示させたいジョブをクリックしてください。

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

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

    失敗したステップの名前

  7. あるいはログの中の特定の行へのリンクを取得するには、そのステップの行番号をクリックします。 Webブラウザのアドレスバーからリンクをコピーできます。

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

ログを検索する

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

  1. GitHubで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下でActions(アクション)をクリックしてください。

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

  3. 左のサイドバーで、表示させたいワークフローをクリックしてください。

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

  4. "Workflow runs(ワークフローの実行)"の下で、表示させたい実行の名前をクリックしてください。

    ワークフローの実行の名前

  5. 左のサイドバーで、表示させたいジョブをクリックしてください。

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

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

    ステップの名前

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

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

Downloading logs

You can download the log files from your workflow run. You can also download a workflow's artifacts. 詳しい情報については「成果物を利用してワークフローのデータを永続化する」を参照してください。

  1. GitHubで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下でActions(アクション)をクリックしてください。

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

  3. 左のサイドバーで、表示させたいワークフローをクリックしてください。

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

  4. "Workflow runs(ワークフローの実行)"の下で、表示させたい実行の名前をクリックしてください。

    ワークフローの実行の名前

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

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

デバッグロギングの有効化

ワークフロージョブあるいはステップが期待どおりに動作しない理由を診断する上で、十分な詳細がワークフローのログになかった場合、追加のデバッグロギングを有効化できます。

これらの追加ログは、ワークフローを含むリポジトリ内の設定シークレットで制御されます。 シークレットの設定に関する詳しい情報については、「暗号化されたシークレットの作成と利用」を参照してください。

ランナーの診断ロギングの有効化

ランナーの診断ロギングは、ランナーによるアクションの実行に関する情報を含む追加のログファイルを提供します。 ログアーカイブには、2つのログファイルが追加されます。

  • ランナープロセスログにはジョブの実行のためのランナーの調整とセットアップに関する情報が含まれます。
  • ワーカープロセスログには、ジョブの実行が記録されます。
  1. ランナー診断ロギングを有効化するには、ワークフローを含むリポジトリ内で以下のシークレットを設定してください: ACTIONS_RUNNER_DEBUGtrueにしてください。

  2. ランナーの診断ログをダウンロードするには、ワークフローの実行のログアーカイブをダウンロードしてください。 ランナーの診断ログはrunner-diagnostic-logsフォルダに含まれています。 For more information on downloading logs, see "Downloading logs."

ステップのデバッグロギングの有効化

酢鉄粉デバッグロギングは、ジョブの実行の間と実行後のジョブのログの詳細度を高めます。

  1. ステップのデバッグロギングを有効化するには、ワークフローを含むリポジトリで以下のシークレットを設定しなければなりません: ACTIONS_STEP_DEBUGtrueにしてください。

  2. このシークレットを設定すると、ステップログにより多くのデバッグイベントが示されるようになります。 詳しい情報については「障害の診断のためのログの閲覧」を参照してください。

参考リンク

担当者にお尋ねください

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

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