github upload-results

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

構文

Shell

codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=<url>] [--repository=<repository-name>] [--ref=<ref>] [--commit=<commit>] [--checkout-path=<path>] <options>...

説明

GitHub コードスキャンに SARIF ファイルをアップロードします。

https://docs.github.com/en/code-security/secure-coding/running-codeql-cli-in-your-ci-system#uploading-results-to-github を参照

GitHub Apps トークンまたは個人用アクセストークンを設定する必要があります。セキュリティのベストプラクティスとして、--github-auth-stdin フラグを設定し、標準入力を介してトークンをコマンドに渡すことをお勧めします。または、GITHUB_TOKEN 環境変数を設定することもできます。

このトークンには、security_events スコープが必要です。

主なオプション

`-s, --sarif=<file>`

[必須] アップロードする SARIF ファイルへのパス。これは、github.com または GitHub AE へのアップロード用の --format sarif-latest を指定した codeql database analyze (または codeql database interpret-results) の出力、あるいは GitHub Enterprise Server インスタンスに適したサポートされている形式タグである必要があります (リリースに適した値については、https://docs.github.com/ を参照してください)。

`-r, --repository=<repository-name>`

アップロードのエンドポイントとして使用する GitHub リポジトリの所有者と名前 (github/octocat など)。これを省略すると、CLI によってチェックアウトパスからの自動検出が試行されます。

`-f, --ref=<ref>`

分析された ref の名前。この ref が pull request マージコミットの場合は、refs/pulls/1234/merge または refs/pulls/1234/head を使用します (このコミットが PR の HEAD または MERGE コミットに対応するかどうかによって異なります)。それ以外の場合は、refs/head/branch-name というブランチである必要があります。省略すると、CLI によって、チェックアウトパスの現在のブランチからの自動設定が試行されます (存在する場合)。

`-c, --commit=<commit>`

分析されたコミットの SHA。これを省略すると、CLI によって、チェックアウトパスからの自動検出が試行されます。

`-p, --checkout-path=<path>`

チェックアウトパス。既定値は現在の作業ディレクトリです。

`--merge`

[詳細設定] 複数の SARIF ファイルを指定し、アップロードする前に単一のファイルにマージできるようにします。これは、下位互換性のためにのみ推奨されます。新しい分析では、カテゴリが異なる 2 つの別の SARIF ファイルをアップロードすることをお勧めします。このオプションは、SARIF バージョン 2.1.0 (CodeQL で使用される SARIF の既定のバージョン) を使用して CodeQL によって生成された SARIF ファイルと組み合わせてのみ機能します。