Skip to main content

デバッグ ログを有効にする

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

Note

GitHub ホステッド ランナーは、現在 GitHub Enterprise Server ではサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

これらの追加ログは、ワークフローを含むリポジトリでシークレットまたは変数を設定することで有効になるため、同じ権限要件が適用されます。

  • GitHub 上で個人用アカウント リポジトリのシークレットまたは変数を作成するユーザーは、リポジトリのオーナーである必要があります。 GitHub 上で組織用リポジトリのシークレットまたは変数を作成するユーザーは、admin アクセス権を持っている必要があります。 最後に、個人用アカウント リポジトリまたは組織用リポジトリのシークレットまたは変数を REST API 経由で作成するユーザーには、コラボレーター アクセス権が必要です。
  • 個人用アカウントのリポジトリ内の環境でシークレットか変数を作成するユーザーは、そのリポジトリのオーナーである必要があります。 組織用リポジトリ内の環境用にシークレットか変数を作成するユーザーには、admin のアクセス権が必要です。 環境について詳しくは、「デプロイに環境の使用」を参照してください。
  • Organization のオーナーは、Organization レベルでシークレットまたは変数を作成できます。

シークレットと変数の設定の詳細については、「GitHub Actions でのシークレットの使用」と「変数に情報を格納する」を参照してください。

さらに、ワークフローを実行するアクセス権を持つすべてのユーザーが、ランナー診断ログとステップ デバッグ ログを有効にして、ワークフローを再実行できます。 詳しくは、「ワークフローとジョブの再実行」を参照してください。

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

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

  • ランナープロセスログにはジョブの実行のためのランナーの調整とセットアップに関する情報が含まれます。
  • ワーカープロセスログには、ジョブの実行が記録されます。
  1. ランナー診断ログを有効にするには、ワークフロー「ACTIONS_RUNNER_DEBUG から true へ」が含まれるリポジトリで次のシークレットまたは変数を設定します: 。 シークレットと変数の両方が設定されている場合、シークレットの値が変数よりも優先されます。
  2. ランナーの診断ログをダウンロードするには、ワークフローの実行のログアーカイブをダウンロードしてください。 ランナーの診断ログは runner-diagnostic-logs フォルダーにあります。 ログのダウンロードについて詳しくは、「ワークフロー実行ログの使用」をご覧ください。

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

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

  1. ステップのデバッグ ログを有効にするには、ワークフロー「ACTIONS_STEP_DEBUG から true へ」が含まれるリポジトリで次のシークレットまたは変数を設定します。 シークレットと変数の両方が設定されている場合、シークレットの値が変数よりも優先されます。
  2. シークレットまたは変数を設定すると、ステップ ログにさらに多くのデバッグ イベントが表示されます。 詳しくは、「ワークフロー実行ログの使用」を参照してください。