github upload-results

Note

此内容描述了 CodeQL CLI 的最新版本。有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。

若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 --help 选项运行命令。

摘要

Shell

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

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

说明

将 SARIF 文件上传到 GitHub 代码扫描。

请参阅：“将 CodeQL 分析结果上传到 GitHub”

必须设置 GitHub Apps 令牌或个人访问令牌。为确保安全，最佳做法是设置 --github-auth-stdin 标志并通过标准输入将令牌传递给命令。或者，可以设置 GITHUB_TOKEN 环境变量。

此令牌必须具有 security_events 范围。

选项

主要选项

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

[必需] 要使用的 SARIF 文件的路径。这应该是 codeql database analyze（或 codeql database interpret-results）的输出，其中 --format sarif-latest 面向到 github.com 的上传内容，或者是相应的 GitHub Enterprise Server 实例支持的格式标记（有关你的版本支持的 SARIF 版本，请参阅对代码扫描的 SARIF 支持）。

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

用作上传终结点的 GitHub 存储库所有者和名称（例如 github/octocat）。如果省略，CLI 将尝试从签出路径自动检测此项。

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

已分析的引用名称。如果此引用是拉取请求合并提交，则使用 refs/pull/1234/merge 或 refs/pull/1234/head（取决于此提交对应于 PR 的 HEAD 还是 MERGE 提交）。否则，此项应是一个分支：refs/heads/branch-name。如果省略，CLI 将尝试从签出路径的当前分支（如果存在）自动填充此项。

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

已分析的提交的 SHA。如果省略，CLI 将尝试从签出路径自动检测此项。

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

签出路径。默认值为当前工作目录。

`--merge`

[高级] 允许指定多个 SARIF 文件，并在上传前将这些文件合并为一个文件。此建议仅旨在实现后向兼容性。对于新的分析，建议上传两个具有不同类别的独立 SARIF 文件。此选项仅适用于 CodeQL 使用 SARIF 2.1.0 版（这是 CodeQL 使用的 SARIF 的默认版本）生成的 SARIF 文件。

`--no-wait-for-processing`

默认情况下，CLI 将等待 GitHub 处理 SARIF 文件最多 2 分钟，如果在处理分析结果的过程中出现任何错误，则返回非零退出代码。可以使用 --wait-for-processing-timeout 自定义 CLI 等待的时间，或者使用 --no-wait-for-processing 禁用该功能。