cargo-publish(1)

名称

cargo-publish — 将包上传到注册表

概要

cargo publish [选项]

描述

此命令将创建一个可分发的压缩 .crate 文件，其中包含当前目录中包的源代码，并将其上传到注册表。默认注册表为 https://crates.io。这将执行以下步骤

执行一些检查，包括
- 检查清单中的 package.publish 键，以限制允许发布到的注册表。
按照 cargo-package(1) 中的步骤创建 .crate 文件。
将包上传到注册表。服务器将对包执行其他检查。
客户端将轮询等待包出现在索引中，并且可能会超时。在这种情况下，您需要手动检查是否完成。此超时不影响上传。

此命令要求您使用 --token 选项或使用 cargo-login(1) 进行身份验证。

有关打包和发布的更多详细信息，请参阅参考。

选项

发布选项

--dry-run

执行所有检查而不上传。

--token 令牌

身份验证时使用的 API 令牌。这将覆盖存储在凭据文件中的令牌（由 cargo-login(1) 创建）。

Cargo 配置环境变量可用于覆盖存储在凭据文件中的令牌。crates.io 的令牌可以使用 CARGO_REGISTRY_TOKEN 环境变量指定。其他注册表的令牌可以使用 CARGO_REGISTRIES_NAME_TOKEN 形式的环境变量指定，其中 NAME 是全部大写的注册表名称。

--no-verify

不要通过构建内容来验证内容。

--allow-dirty

允许打包具有未提交 VCS 更改的工作目录。

--index 索引

要使用的注册表索引的 URL。

--registry 注册表

要发布到的注册表的名称。注册表名称在 Cargo 配置文件中定义。如果未指定，并且 Cargo.toml 中有一个 package.publish 字段，其中包含单个注册表，则它将发布到该注册表。否则，它将使用默认注册表，该注册表由 registry.default 配置键定义，默认为 crates-io。

包选择

默认情况下，将选择当前工作目录中的包。-p 标志可用于在工作空间中选择不同的包。

-p 规范
--package 规范: 要发布的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。

编译选项

--target 目标架构

发布给定的体系结构。默认值为主机体系结构。目标架构的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 以获取支持的目标列表。此标志可以指定多次。

这也可以使用 build.target 配置值指定。

请注意，指定此标志会使 Cargo 以不同的模式运行，在这种模式下，目标工件将放置在单独的目录中。有关更多详细信息，请参阅构建缓存文档。

--target-dir 目录

所有生成的工件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值指定。默认为工作空间根目录中的 target。

功能选择

功能标志允许您控制启用哪些功能。如果未给出功能选项，则会为每个选定的包激活 default 功能。

有关更多详细信息，请参阅功能文档。

-F 功能
--features 功能: 要激活的功能的空格或逗号分隔列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。此标志可以指定多次，这将启用所有指定的功能。
--all-features: 激活所有选定包的所有可用功能。
--no-default-features: 不要激活所选包的 default 功能。

清单选项

--manifest-path 路径

Cargo.toml 文件的路径。默认情况下，Cargo 在当前目录或任何父目录中搜索 Cargo.toml 文件。

--locked

断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时完全相同。在出现以下任何一种情况时，Cargo 将退出并报错

缺少锁文件。
由于不同的依赖项解析，Cargo 尝试更改锁文件。

它可以在需要确定性构建的环境中使用，例如在 CI 管道中。

--offline

阻止 Cargo 出于任何原因访问网络。如果没有此标志，Cargo 在需要访问网络且网络不可用时将停止并报错。使用此标志，Cargo 将尝试在可能的情况下在没有网络的情况下继续进行。

请注意，这可能会导致与在线模式不同的依赖项解析。Cargo 将限制自己使用本地下载的 crate，即使索引的本地副本中可能指示了更新的版本。请参阅 cargo-fetch(1) 命令以在脱机之前下载依赖项。

也可以使用 net.offline 配置值指定。

--frozen

等效于同时指定 --locked 和 --offline。

其他选项

-j N

--jobs N

要运行的并行作业数。也可以使用 build.jobs 配置值指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 数加上提供的值。如果提供了字符串 default，则会将值设置回默认值。不应为 0。

--keep-going

在依赖图中尽可能多地构建 crate，而不是在第一个构建失败时中止构建。

例如，如果当前包依赖于依赖项 fails 和 works，其中一个构建失败，则 cargo publish -j1 可能会也可能不会构建成功的那个（取决于 Cargo 选择首先运行的两个构建中的哪一个），而 cargo publish -j1 --keep-going 肯定会运行这两个构建，即使第一个构建失败。