Skip to main content

Enterprise Server 3.16 は、現在リリース候補として使用できます。

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

CodeQL のトラブルシューティング情報を含むデータベース バンドルを作成できます。

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

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

Warning

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

CodeQL CLI データベース バンドルの作成について

Note

この記事では、GitHub Enterprise Server 3.16 の初期リリースに含まれている CodeQL CLI 2.20.3 バンドルで使用できる機能について説明します。

サイト管理者が CodeQL CLI のバージョンをより新しいリリースに更新している場合は、この記事の GitHub Enterprise Cloud バージョンで最新の機能に関する情報を参照してください。

CodeQL CLI データベース バンドル コマンドを使って、CodeQL データベースの再配置可能なアーカイブを作成できます。

データベース バンドルのコピーを使って、チーム メンバーまたは GitHub Support とトラブルシューティング情報を共有できます。

トラブルシューティング目的でデータベース バンドルを作成する場合は、次の CodeQL CLI コマンド構文をお勧めします。

Note

このサンプル 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 createdatabase analyze の詳細度を高める

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

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