Skip to main content

このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2024-03-07. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

diagnostic add

[試験的] [プラミング] 診断情報の一部を追加します。

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

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 diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

説明

[試験的] [プラミング] 診断情報の一部を追加します。

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

[オプション]

主なオプション

--markdown-message=<markdownMessage>

診断のメッセージ (GitHub フレーバーの Markdown 形式)。

--plaintext-message=<plaintextMessage>

診断のメッセージ (プレーンテキスト)。 このオプションは、Markdown メッセージに --markdown-message を設定する場合にのみ使用する必要があります。これは実用的ではありません。

--severity=<severity>

診断の重大度。 "error"、"warning"、または "note" を指定できます。

診断に関連するヘルプ リンク。

--attributes-json=<attributesJson>

診断に関連する構造化メタデータ。

診断情報を保存する場所を指定するオプション

これらのオプションの 1 つだけを指定する必要があります。

--diagnostic-dir=<diagnosticDir>

診断を追加する必要のあるディレクトリ。

診断メッセージを表示できる場所を示すオプション

--ready-for-status-page

診断が状態ページに表示するのに適していることを示します。

--ready-for-cli-summary-table

database analyze などのコマンドによって出力される診断概要テーブルでの表示に診断が適していることを示します。

診断のソースを記述するオプション

--source-id=<id>

[必須] この診断のソースの識別子。

--source-name=<name>

[必須] この診断のソースの人間が判読できる説明。

--extractor-name=<extractorName>

CodeQL エクストラクターによってこの診断が生成された場合の CodeQL エクストラクターの名前。

診断の場所を記述するオプション

--file-path=<file>

ソース ルートを基準とした、診断が適用されるファイルの相対パス。

--start-line=<startLine>

診断の場所が開始される 1 から始まる行番号 (1 を含む)。

--start-column=<startColumn>

診断の場所が開始される 1 から始まる列番号 (1 を含む)。

--end-line=<endLine>

診断の場所が終了する 1 から始まる行番号 (1 を含む)。

--end-column=<endColumn>

診断の場所が終了する 1 から始まる列番号 (1 を含む)。

共通オプション

-h, --help

このヘルプ テキストを表示します。

-J=<opt>

[詳細設定] コマンドを実行している JVM にオプションを指定します

(スペースを含むオプションは正しく処理されないことに注意してください)。

-v, --verbose

出力される進行状況メッセージの数を段階的に増やします。

-q, --quiet

出力される進行状況メッセージの数を段階的に減らします。

--verbosity=<level>

[詳細設定] 詳細レベルを、errors、warnings、progress、progress+、progress++、progress+++ のいずれかに明示的に設定します。 -v-q がオーバーライドされます。

--logdir=<dir>

[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます

(完全に制御できる名前でログ ファイルを書き込むには、代わりに --log-to-stderr を指定し、必要に応じて stderr をリダイレクトします)。

--common-caches=<dir>

[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、既定ではユーザーのホーム ディレクトリに名前が付けられた .codeql ディレクトリになります。まだ存在しない場合は作成されます。

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