包发布

Note

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

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

摘要

Shell

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 属于以下情况，则包含给定工作区中的 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 and GITHUB_TOKEN 环境变量。如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 --github-auth-stdin 选项进行身份验证。

`--github-auth-stdin`

通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。

若要向 GitHub Enterprise Server 容器注册表进行身份验证，请传递 --registries-auth-stdin 或使用 CODEQL_REGISTRIES_AUTH 环境变量。

这会替代 GITHUB_TOKEN 环境变量。

包发布

谁可以使用此功能？

本文内容

摘要

说明

选项

主要选项

`<dir>`

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

`--no-keep`

`-j, --threads=<num>`

`-M, --ram=<MB>`

`--no-precompile`

`--no-validate-extensions`

`--no-overwrite`

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

`--file=<package.tgz>`

`--[no-]allow-prerelease`

用于配置要向其应用此命令的 CodeQL 包的选项。

`--format=<fmt>`

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

用于设置编译环境的选项

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

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

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

`--dbscheme=<file>`

`--compilation-cache=<dir>`

`--no-default-compilation-cache`

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

`--registries-auth-stdin`

`--github-auth-stdin`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`