42_发布crate

1. 创建账号

  • 发布crate.io前,需要在<crates.io>创建账号并获得API Token
  • 运行命令cargo login $API_TOKEN
    • 将会通知cargo,把你的API token存储在本地 ~/.cargo/credentials.toml
    • API Token可以在<crates.io>上进行撤销。

2. crate添加元数据

在发布crate之前,需要在Cargo.toml[package]区域为crate添加一些元数据:

  • name: crate需要指定位于的名称
  • description: 一两句话即可,会出现在crate搜索的结果里
  • license: 需要提供许可证的表示值,可以到spdx.org/licenses/查找,可以指定多个许可,使用OR隔开
  • version: 版本号
  • author: 作者

更多的原数据可以参考doc.rust-lang.org/cargo/refer...

下面是一个示例的原数据:

ini 复制代码
[package]
name = "first_crate_yinuo"
version = "0.1.0"
author = ["kotlindev"]
edition = "2021"
description = "A Rust tutorials"
license = "MIT"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]

3. 发布crate

未提交代码使用cargo publish --allow-dirty测试。 使用cargo pushlish进行发布。要注意的是,如果发布失败,原因可能是因为你的<crates.io>的账号还没绑定验证的邮箱,或者你的crate的元信息缺失,需要根据错误提示补充即可。

crate一旦发布,就是永久性的:该版本无法覆盖,代码无法删除。因为<crates.io>希望成为永久的代码托管服务器,并且依赖于该版本的项目可以继续正常工作。如果允许开发者删除已经发布的代码,那么将无法达到这个目的。

4. 发布已存在的crate新版本

在修改crate的代码之后,当我们需要发布新版本时,需要先修改Cargo.toml里面的version值。可以参考语义化版本控制规范semver.org来定义你的语意版本。最后执行cargo publish进行发布。

5. 使用cargo yank从crates.io撤回版本

我们不可以删除之前的版本,不会删除任何代码,但可以防止其他项目把某个版本最为新的依赖,使用yank可撤回一个crate版本即可。该操作防止新项目依赖于该版本,但已经存在的项目可以继续将其作为依赖并可以下载。

yank意味着:所有已经产生Cargo.lock的项目不会中断,同时任何将来新生成的Cargo.lock文件都不会使用被yank的版本。

撤回命令如下示例:

bash 复制代码
cargo yank --version 1.0.1

取消撤回如下命令

bash 复制代码
cargo yank --version 1.0.1 --undo
相关推荐
学习使我快乐013 小时前
JS进阶 3——深入面向对象、原型
开发语言·前端·javascript
bobostudio19953 小时前
TypeScript 设计模式之【策略模式】
前端·javascript·设计模式·typescript·策略模式
黄尚圈圈4 小时前
Vue 中引入 ECharts 的详细步骤与示例
前端·vue.js·echarts
浮华似水5 小时前
简洁之道 - React Hook Form
前端
正小安7 小时前
如何在微信小程序中实现分包加载和预下载
前端·微信小程序·小程序
_.Switch9 小时前
Python Web 应用中的 API 网关集成与优化
开发语言·前端·后端·python·架构·log4j
一路向前的月光9 小时前
Vue2中的监听和计算属性的区别
前端·javascript·vue.js
长路 ㅤ   9 小时前
vite学习教程06、vite.config.js配置
前端·vite配置·端口设置·本地开发
长路 ㅤ   9 小时前
vue-live2d看板娘集成方案设计使用教程
前端·javascript·vue.js·live2d