Skip to main content

CodeQL CLI データベース バンドルを作成する

CodeQL トラブルシューティング情報を使用してデータベース バンドルを作成します。

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

  • GitHub.com のパブリック リポジトリについては、「GitHub CodeQL の使用条件」を参照してください
  • GitHub Code Security が有効になっている GitHub Team または GitHub Enterprise Cloud 上の organization 所有のリポジトリ

警告

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

トラブルシューティングのためにデータベース バンドルを作成するときは、次の CodeQL CLI コマンド構文をお勧めします。 このサンプル database bundle コマンドには、CodeQL CLI バージョン 2.17.6 以降が必要です。

codeql database bundle --output=codeql-debug-artifacts.zip --include-diagnostics --include-logs --include-results -- <dir>

このコマンドの場合、<dir> は、CodeQL データベースが作成されたディレクトリのパスにする必要があります。

このコマンドの実行が成功すると、CodeQL のトラブルシューティング情報を含む codeql-debug-artifacts.zip という ZIP ファイルが作成されます。 そのファイルは、データベース バンドルです。

このコマンドは、--log-dir コマンド ライン引数が database create および database analyze コマンドで使われていないことを前提としています。 そのコマンド ライン引数を使用すると、それらのコマンドが作成したログ ファイルはデータベース バンドルに含まれません。

          `database create` と `database analyze` の詳細度を高める

トラブルシューティング目的において、database create および database analyze コマンドの詳細度が足りない場合は、詳細度を高めることができます。

どちらのコマンドも、データベース バンドルを作成する前に --verbosity に設定できる progress++ コマンド ライン引数をサポートしています。