pack publish

摘要

codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>

codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>

描述

将 QL 库包发布到包注册表。

此命令将包发布到包注册表。发布前，首先会编译（如有必要）并捆绑包。

自 v2.6.0 起可用。

选项

主要选项

<dir>

包或工作区的根目录，默认为当前工作目录。如果此参数指向包含 qlpack.yml 的目录，则此操作将仅对该 CodeQL 包运行。如果此参数指向包含 codeql-workspace.yml 的目录，则此操作将对工作区中的所有 CodeQL 包运行。

-n, --[no-]dry-run

打印本来会执行的操作，但实际上不发布包。

--no-keep

发布后删除包捆绑。

-j, --threads=<num>

使用这么多线程来编译查询。

默认为 1。您可以传递 0 以在机器上使用每个内核一个线程，或 -N 以保留 N 个内核未使用（但仍至少使用一个线程）。

-M, --ram=<MB>

设置编译器允许使用的 RAM 总量。

--no-precompile

[高级] 避免在包输出目录中预编译编译缓存。这将减少包的大小和创建它所需的时间，但需要在运行包之前进行编译。仅对查询包有意义。

--no-validate-extensions

[高级] 避免在编译步骤中验证数据扩展。

自 v2.13.3 起可用。

--no-overwrite

[高级] 避免重新编译和覆盖以前调用此命令时生成的任何现有编译输出。

-p, --pack=<folder> | <package.tgz>

[高级] 将打包的 tarball 放置到的位置。如果此选项以 .tgz 结尾，则将使用该名称创建 tarball。否则，将在指定路径处创建一个新目录，并在其中创建一个或多个 tarball。对于工作区不允许使用 .tgz。

--file=<package.tgz>

[高级] 将 package.tgz 直接上传到包注册表，而无需尝试创建或捆绑任何新内容。

--[no-]allow-prerelease

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

自 v2.11.3 起可用。

用于配置要对此命令应用哪些 CodeQL 包的选项。

--format=<fmt>

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

--groups=[-]<group>[,[-]<group>...]

要包含或排除在此操作之外的 CodeQL 包组列表。如果满足以下条件，则给定工作区中的 qlpack 将被包含

• 它至少在一个没有减号的列出的组中（如果没有任何没有减号的组列出，则此条件会自动满足），并且
• 它不属于任何带减号的列出的组

用于设置编译环境的选项

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

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

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

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

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

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

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

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

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

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

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

[高级] 将添加到 QL 库的原始导入搜索路径的可选目录列表。仅当您使用尚未打包为 QL 包的 QL 库时，才应使用此选项。

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

--dbscheme=<file>

【高级】明确定义应针对哪个 dbscheme 查询进行编译。只有在极其确定操作的情况下，调用方才应提供此选项。

--compilation-cache=<dir>

【高级】指定一个额外的目录作为编译缓存。

--no-default-compilation-cache

【高级】不要使用标准位置的编译缓存，例如包含查询的 QL 包或 CodeQL 工具链目录中的缓存。

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 版本起可用。