快速上手
第一条 vbumpp 命令
安装
按你的环境任选一种安装方式,功能完全一致:
- npm(Node.js 项目首选):
npm install -D @vill-v/bumpp,详见安装 · npm - cargo binstall(免编译,推荐):
cargo binstall vbumpp直接下载预编译原生 CLI,不需要 Node.js 环境,也无需本地编译 - cargo install:
cargo install vbumpp从 crates.io 拉取源码本地编译
预编译产物覆盖以下平台(npm 包与原生 CLI 一致):
| 平台 | 预编译产物 |
|---|---|
| macOS(Apple Silicon) | ✔ |
| macOS(Intel) | ✘ |
| Linux(x64 / arm64,含 Alpine) | ✔ |
| Windows(x64 / arm64) | ✔ |
未覆盖的平台(如 Intel Mac):npm 包不支持,请改走 crates.io 安装;cargo binstall 会自动回退源码编译。完整覆盖矩阵见安装 · crates.io;想跟进最新未发布改动,还可以从源码编译安装。
第一条命令
在项目根目录(package.json 或 Cargo.toml 所在处)执行:
vbumpp会出现一个交互菜单让你选择新版本怎么算:
patch/minor/major:按 semver 递增prepatch/preminor/premajor/prerelease:发预发布版本(如1.1.0-beta.1)conventional:根据自上次发版以来的 conventional commits 自动推断next:取当前版本的下一个递增none:保持当前版本不变;custom:手动输入版本号
选定后,工具会依次自动完成:
- 根据最近一个 git tag 以来的提交生成变更记录,写入
CHANGELOG.md - 更新版本文件中的版本号
- 执行你在配置里声明的发版脚本(如有)
- git commit → 打 tag → push
- 装了平台包(如
@vill-v/bumpp-gitee)或给出--provider时,在该平台创建 Release
仓库还没有任何 git tag 时会跳过 changelog 生成。
常见用法
vbumpp # 标准发版
vbumpp -r # monorepo:递归更新整树包的版本
vbumpp package.json docs/v.txt # 只更新指定的版本文件
vbumpp -o HISTORY.md # changelog 写到别的文件