github upload-results

注意

此内容描述了 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 应用令牌或个人访问令牌。为遵循最佳安全实践，建议使用 --github-auth-stdin 标志，并通过标准输入将令牌传递给命令。或者，也可以设置 GITHUB_TOKEN 环境变量。

此令牌必须具备 security_events 权限范围。

[必需] 要使用的 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>`

已分析的引用（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 版本）文件一起使用时有效。

`--no-wait-for-processing`

默认情况下，CLI 会等待 GitHub 处理 SARIF 文件，最长 2 分钟；如果在处理分析结果期间出现任何错误，CLI 将返回非零退出码。您可以使用 --wait-for-processing-timeout 自定义等待时长，或使用 --no-wait-for-processing 禁用此功能。