問題のトラブルシューティングに十分な詳細がログにない場合は、追加の情報を取得し、ログをより便利にするために実行できるいくつかの手順があります。
ステップのデバッグ ログの有効化
GitHub Actions 内でステップ デバッグ ログを有効にし、ジョブの実行中にジョブのログの詳細度を高めることができます。 詳しくは、「デバッグ ログを有効にする」をご覧ください。
CodeQL デバッグ成果物の作成
警告
CodeQL デバッグ成果物は、CodeQL によって分析されるソース コードのコピーを保持しているため、これらのバンドルは、そのソース コードへのアクセスが許可されているユーザーとのみ共有することをお勧めします。
CodeQL のデバッグに役立つ成果物を取得できます。
デバッグ 成果物は、名前が debug-artifacts で始まる成果物としてワークフロー実行にアップロードされます。 CodeQL がワークフロー実行の一部として複数の言語を同時に分析する場合、言語ごとにこのような成果物が 1 つ存在します。 データには、CodeQL ログ、CodeQL データベース、抽出されたソース コード ファイル、およびワークフローによって生成されたすべての SARIF ファイルが含まれます。 CodeQL 成果物のダウンロードの詳細については、「ワークフローの成果物をダウンロードする」を参照してください。
これらの成果物は、CodeQL code scanningに関する問題をデバッグするのに役立ちます。 GitHub サポートに問い合わせた場合、このデータを要求される場合があります。
CodeQL の既定のセットアップに対応する、CodeQL デバッグ成果物の作成
CodeQL デバッグ成果物を作成することができます。そうするには、GitHub Actions ステップ デバッグ ログを有効にし、新しい CodeQL 分析をトリガーします。たとえば、新しいコミットを、pull request (プル リクエスト) ブランチにプッシュすることがあります。 GitHub Actionsのステップデバッグログを有効にする方法については、デバッグ ログを有効にするを参照してください。
プライベートレジストリに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 はデバッグ成果物も生成してアップロードします。 「デバッグ ログを有効にする」を参照してください。