介绍
版本管理通常用于前端库,例如 Vue v2.7.0 Vue v3.4.0 , 通过版本发布不同的包。在 Web 项目中版本管理其实不多见,但是也有适用场景,例如线上环境和测试环境部署的包一旦出 BUG ,可以根据控制台的版本号找到相应 Git Tag 定位问题。市面上的版本标记工具基本都是为库打造的,每次手动修改版本号太过于麻烦。于是我写了个更适合 Web 项目的版本标记工具—— version-mark,帮助开发者更好地标记项目版本。
version-mark 基于 Git 版本管理,在控制台通过交互式的形式,同步修改 package.json 和进行 Git Tag 标记。
功能特点
-
version-mark能够自动检测当前工作目录中的更改情况。如果有未提交的更改,属于临时发布,只提供预发布版本选项;如果当前更改都已提交,将提供正式版和预发布版本选项。 -
版本号更新策略
Version Mark支持以下版本号更新策略:
- patch:0.0.1
- minor:0.1.0
- major:1.0.0
- prepatch:0.0.1-2024
- preminor:0.1.0-2024
- premajor:1.0.0-2024
-
自动更新
package.json中的版本号。 -
创建并推送新的
git标签。如果工作区还有未提交的更改,只更新
package.json版本号。已提交更改,自动创建新的git标签,并向远程仓库推送。
安装
pnpm add version-mark -D
yarn add version-mark -D
npm install version-mark -D
使用
在项目中的 package.json 文件中添加以下脚本:
{
"scripts": {
"version": "vmark",
"build": "vmark && pnpm run build"
}
}
然后,运行以下命令:
pnpm run build
终端将显示当前版本号及可选的版本号更新选项。以下是一个示例输出:
配合 vite-plugin-version-mark 使用即可在控制台输出版本号。
注意事项
使用Version Mark时,请确保以下几点:
package.json文件位于当前工作目录中;git仓库已配置远程仓库。
最后再放一下 GitHub 地址,觉得感兴趣的帮忙点个 Star。