Skip to main content

创建 CodeQL CLI 数据库捆绑包

可以使用 CodeQL 故障排除信息创建数据库捆绑包。

谁可以使用此功能?

CodeQL 可用于以下存储库类型:

Warning

CodeQL CLI 数据库捆绑包包含 CodeQL 正在分析的源代码的副本,因此建议仅与有权访问该源代码的人员共享这些捆绑包。

关于创建 CodeQL CLI 数据库捆绑包

Note

本文介绍了 GitHub Enterprise Server 3.15 的初始发行版中包含的 CodeQL CLI 2.20.3 捆绑包中可用的功能。

如果站点管理员已将 CodeQL CLI 版本更新为较新版本,请参阅本文的 GitHub Enterprise Cloud 版本,了解有关最新功能的信息。

CodeQL CLI 数据库捆绑命令可用于创建 CodeQL 数据库的可重定位存档。

数据库捆绑包的副本可用于与团队成员或 GitHub 支持 共享故障排除信息。

创建数据库捆绑包以进行故障排除时,建议使用以下 CodeQL CLI 命令语法:

Note

此示例 database bundle 命令需要 CodeQL CLI 版本 2.17.6 或更高版本。

codeql database bundle --output=codeql-debug-artifacts.zip --include-diagnostics --include-logs --include-results -- <dir>

对于此命令,<dir> 必须是 CodeQL 数据库创建目录的路径。

成功执行命令后会创建一个名为 codeql-debug-artifacts.zip 的 zip 文件,其中包含 CodeQL 故障排除信息。 该文件是数据库捆绑包。

此命令假定 --log-dir 命令行参数未用于 database create 命令和 database analyze 命令。 使用该命令行参数时,这些命令创建的日志文件不会包含在数据库捆绑包中。

增加 database createdatabase analyze 的详细程度

如果命令 database createdatabase analyze 的详细程度不足以进行故障排除,可以增加其详细程度。

这两个命令都支持 --verbosity 命令行参数,后者可在创建数据库捆绑包之前设置为 progress++