包升级

将此包的依赖项更新到最新可用版本。

谁可以使用此功能？

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

本文内容

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

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

概要

Shell
codeql pack upgrade [--force] <options>... -- <dir>

说明

将此包的依赖项更新到最新可用版本。

此命令安装每个包依赖项的最新兼容版本，并使用新获取的版本更新锁定文件。任何现有的锁定文件都将被忽略。

自 v2.6.3 起可用。

选项

主要选项

<dir>

包的根目录。

--format=<fmt>

选择输出格式，text（默认）或 json。

-f, --[no-]force

允许覆盖已存在的包。

--[no-]allow-prerelease

允许使用带有预发行版本限定符（例如，X.Y.Z-qualifier）的包。没有此标志，预发行包将被忽略。

自 v2.11.3 起可用。

--lock-override=<file>

[高级] 指定要作为依赖项解析输入使用的备用锁定文件。

--lock-output=<file>

[高级] 指定保存依赖项解析生成的锁定文件的备用位置。

自 v2.14.1 起可用。

--no-strict-mode

[高级] 关闭严格模式以避免在从 --additional-packs

和其他本地解析位置解析包时出现警告。本地解析的包永远不会下载

并且不会添加到包锁定文件中。

用于配置包注册表外部的 QL 包解析的选项

--search-path=<dir>[:<dir>...]

可在其下找到 QL 包的目录列表。每个目录可以是 QL 包（或包含根目录中 .codeqlmanifest.json 文件的包捆绑包）或一个或多个此类目录的直接父目录。

如果路径包含多个目录，则它们的顺序定义它们之间的优先级：当必须解析的包名称在一个以上的目录树中匹配时，首先给出的目录获胜。

指向开源 CodeQL 存储库的检出应该在查询其中存在的语言之一时有效。

如果您已将 CodeQL 存储库检出为解压的 CodeQL 工具链的同级目录，则无需提供此选项；始终会搜索此类同级目录以查找无法找到的 QL 包。（如果此默认值不起作用，强烈建议一次性在每个用户的配置文件中设置 --search-path）。

（注意：在 Windows 上，路径分隔符为 ;）。

--additional-packs=<dir>[:<dir>...]

如果提供了此目录列表，则在 --search-path 中的目录之前搜索这些目录。它们之间的顺序无关紧要；如果通过此列表在两个不同位置找到包名称，则这是一个错误。

如果您暂时正在开发一个也在默认路径中出现的包的新版本，则此功能非常有用。另一方面，_不建议_在配置文件中覆盖此选项；某些内部操作将动态添加此选项，从而覆盖任何已配置的值。

（注意：在 Windows 上，路径分隔符为 ;）。

用于配置 CodeQL 包管理器的选项

--registries-auth-stdin

通过传递以逗号分隔的 <registry_url>=<token> 对列表来对 GitHub Enterprise Server 容器注册表进行身份验证。

例如，您可以传递 https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 来对两个 GitHub Enterprise Server 实例进行身份验证。

这会覆盖 CODEQL_REGISTRIES_AUTH 和 GITHUB_TOKEN 环境变量。如果您只需要认证到 github.com 容器注册表，则可以使用更简单的 `--github-auth-stdin` 选项。

--github-auth-stdin

通过标准输入传递 github.com GitHub Apps 令牌或个人访问令牌，来认证到 github.com 容器注册表。

要认证到 GitHub Enterprise Server 容器注册表，请传递 `--registries-auth-stdin` 或使用 CODEQL_REGISTRIES_AUTH 环境变量。

这会覆盖 GITHUB_TOKEN 环境变量。

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

[高级] 为运行命令的 JVM 提供选项。

(请注意，包含空格的选项将无法正确处理。)

-v, --verbose

逐步增加打印的进度消息数量。

-q, --quiet

逐步减少打印的进度消息数量。

--verbosity=<level>

[高级] 将详细程度明确设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。覆盖 `-v` 和 `-q`。

--logdir=<dir>

[高级] 将详细日志写入给定目录中的一个或多个文件，生成的名称包括时间戳和正在运行的子命令的名称。

(要写入名称完全受您控制的日志文件，请改用 `--log-to-stderr` 并根据需要重定向 stderr。)

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的存储位置，这些数据将在 CLI 的多次运行之间持续存在，例如下载的 QL 包和已编译的查询计划。如果未显式设置，则默认为用户主目录中名为 `.codeql` 的目录；如果该目录不存在，则会创建它。

自 `v2.15.2` 版本起可用。