database export-diagnostics

[試験的] データベースから失敗した分析の診断情報をエクスポートします。

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

GitHub CodeQL は、インストール時にユーザーごとにライセンスされます。 CodeQL は、ライセンスの制限の下で特定のタスクでのみ使用できます。詳しくは、「CodeQL CLI について」を参照してください。

GitHub Advanced Security ライセンスがある場合は、CodeQL を使用して、自動分析、継続的インテグレーション、継続的デリバリーを行うことができます。詳しくは、「GitHub Advanced Security について」を参照してください。

この記事の内容

このコンテンツでは、CodeQL CLI の最新リリースについて説明します。このリリースについて詳しくは、 https://github.com/github/codeql-cli-binaries/releases をご覧ください。

以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help オプションを指定してコマンドを実行してください。

構文

Shell

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

説明

[試験的] データベースから失敗した分析の診断情報をエクスポートします。

v2.12.6 以降で使用できます。

[オプション]

主なオプション

`<database>`

[必須] 構築中の CodeQL データベースへのパス。これは、codeql database init を使って抽出するために準備されている必要があります。

--db-cluster オプションを指定した場合、これはデータベース自体ではなく、データベースを "含む" ディレクトリであり、これらのデータベースはすべてまとめて処理されます。__

`--format=<format>`

[必須] 結果を書き込む形式。つぎのいずれかです。

raw: 未処理の未解釈の診断メッセージの一覧を JSON オブジェクトとして指定します。

sarif-latest: Static Analysis Results Interchange Format (SARIF)。静的な分析結果を記述するための JSON ベースの形式。この形式オプションでは、サポートされている最新バージョン (v2.1.0) が使用されます。このオプションは、異なる CodeQL バージョン間で異なるバージョンの SARIF が生成されるため、自動化での使用には適していません。

sarifv2.1.0: SARIF v2.1.0。

text: 診断メッセージの箇条書き。

`--[no-]db-cluster`

コマンドラインで指定されたディレクトリがデータベース自体ではなく、構築中の 1 つ以上のデータベースを "含む" ディレクトリであることを示します。__ これらのデータベースはまとめて処理されます。

`-o, --output=<output>`

診断情報を書き込む出力パス。

`--sarif-exit-code=<sarifExitCode>`

[SARIF 形式のみ] 失敗したプロセスの終了コード。

`--sarif-exit-code-description=<sarifExitCodeDescription>`

[SARIF 形式のみ] 失敗したプロセスが終了した理由。

`--sarif-category=<category>`

[SARIF 形式のみ] [推奨] SARIF 出力に含めるこの分析のカテゴリを指定します。カテゴリを使用して、同じコミットとリポジトリ (ただし、異なる言語またはコードの異なる部分) で実行される複数の分析を区別できます。

同じバージョンのコードベースを複数の異なる方法で分析し (たとえば、言語が異なる場合)、コードスキャンでプレゼンテーションするために GitHub に結果をアップロードする場合、この値は各分析間で異なる必要があります。これにより、コードスキャンに対して、分析では互いに ''置き換える'' のではなく ''補足する'' ことが示されます __ __ (コードベースの ''異なる'' バージョンに対して同じ分析の実行間で値の一貫性を保つ必要があります)。__

この値は <run>.automationDetails.id プロパティとして表示されます (存在しない場合は末尾にスラッシュが追加される)。

database export-diagnostics

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

この記事の内容

構文

説明

[オプション]

主なオプション

`<database>`

`--format=<format>`

`--[no-]db-cluster`

`-o, --output=<output>`

`--sarif-exit-code=<sarifExitCode>`

`--sarif-exit-code-description=<sarifExitCodeDescription>`

`--sarif-category=<category>`

共通オプション

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`