ログの詳細が十分ではありません

問題のトラブルシューティングに十分な詳細がログにない場合は、追加の情報を取得し、ログをより便利にするために実行できるいくつかの手順があります。

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

ステップデバッグログを使用すると、実行中と実行後にジョブのログの詳細度が向上します。

ステップデバッグログを有効にするには:

ワークフローを含むリポジトリで、次のシークレットまたは変数を設定します。 ACTIONS_STEP_DEBUG を true に設定します。シークレットと変数の両方が設定されている場合、シークレットの値が変数よりも優先されます。
ワークフローを再実行するか、新しい実行をトリガーします。

シークレットまたは変数を設定すると、ステップログにさらに多くのデバッグイベントが表示されます。「ワークフロー実行ログの使用」を参照してください。

また、デバッグログが有効な場合にのみ、 runner.debug コンテキストを使用してステップを条件付きで実行することもできます。「コンテキストリファレンス」を参照してください。

CodeQL デバッグ成果物の作成

警告

CodeQL デバッグ成果物は、CodeQL によって分析されるソースコードのコピーを保持しているため、これらのバンドルは、そのソースコードへのアクセスが許可されているユーザーとのみ共有することをお勧めします。

CodeQL のデバッグに役立つ成果物を取得できます。デバッグ成果物は、名前が debug-artifacts で始まる成果物としてワークフロー実行にアップロードされます。 CodeQL がワークフロー実行の一部として複数の言語を同時に分析する場合、言語ごとにこのような成果物が 1 つ存在します。データには、CodeQL ログ、CodeQL データベース、抽出されたソースコードファイル、およびワークフローによって生成されたすべての SARIF ファイルが含まれます。 CodeQL 成果物のダウンロードの詳細については、「ワークフローの成果物をダウンロードする」を参照してください。

これらの成果物は、CodeQL code scanningに関する問題をデバッグするのに役立ちます。 GitHub のサポートにお問い合わせの場合、このデータを要求される場合があります。

CodeQL の既定のセットアップに対応する、CodeQL デバッグ成果物の作成

CodeQL デバッグ成果物を作成するには、ステップデバッグロギングを有効にして（ステップデバッグロギングの有効化を参照）、新しい CodeQL 分析をトリガーします。たとえば、新しいコミットをプルリクエストブランチにプッシュします。

これらの手順に従ってください:

プライベートレジストリにCodeQL アクセス権を付与した場合、名前が proxy-log-file で始まる追加の成果物が利用可能になります。これには、CodeQL の既定のセットアップでプライベートレジストリへの要求を認証するために使用される認証プロキシのログが含まれており、プライベートレジストリ構成のトラブルシューティングに使用できます。詳細については、「セキュリティ機能にプライベートレジストリへのアクセスを許可する」を参照してください。

CodeQL の詳細セットアップに対応する、CodeQL デバッグ成果物の作成

CodeQL の詳細セットアップに対応するデバッグ成果物は、数種類の方法で取得できます。

デバッグログを有効にしてジョブを再実行する

CodeQL の詳細設定のデバッグ成果物を作成する最も簡単なオプションは、デバッグログを有効にしてジョブを再実行することです。 GitHub Actions のワークフローとジョブの再実行について詳しくは、「ワークフローとジョブの再実行」を参照してください。

必ず [デバッグログの有効化] を選ぶ必要があります。このオプションにより、実行でランナー診断ログとステップデバッグログが有効になります。次に、CodeQLのデバッグ用ファイルをダウンロードでき、そのファイルを使ってさらに調査を進めることができます。ジョブを再実行して CodeQL デバッグ成果物を作成するときに、ワークフローファイルを変更する必要はありません。

ワークフローフラグの使用

ワークフローでフラグを使用して CodeQL デバッグ成果物を作成できます。このためには、CodeQL 分析ワークフローファイルの init ステップを変更して debug: true を設定する必要があります。

- name: Initialize CodeQL
  uses: github/codeql-action/init@v4
  with:
    debug: true

GitHub Actions ステップデバッグログを使用

GitHub Actions ステップデバッグログを有効にした場合、CodeQL はまたデバッグ成果物を生成し、それらをワークフロー実行の一部としてアップロードします。手順については、「ステップデバッグログの有効化」を参照してください。

この記事で