前言
万物皆可配置,版本号也不例外。使用诸如 2.1.3
等形式的版本号标记软件的语义化版本控制(Semantic Versioning,简称 SemVer)已经成为了通用做法。为了让版本号在不同的软件之间规范化,SemVer 指定了一套标准的版本命名规则,定义了版本号的格式和内容。
但是,在实际的开发中,需要编写的文件可能涉及到多种语言和质量控制,对于版本号的语义化控制和规范化管理变得十分重要。为此,我们有了 @wrench/standard-version-config
这一 npm 包。
@wrench/standard-version-config 简介
@wrench/standard-version-config
是针对前端工程项目的标准版本控制配置工具。通过使用这个包,可以方便地为项目制定多种语言的语义化版本、版本号及发布计划,确保符合语义化版本控制规范。
该包的主要功能如下:
- 使用简单,只需安装后在项目配置文件中进行简单配置即可;
- 具有多种语言及版本情况下的配置方式;
- 可自定义发布前的版本号升级操作,如在修复 bug 后自动升级次版本号、在重构后自动升级主版本号等。
安装
通过 npm 安装:
npm install @wrench/standard-version-config --save-dev
配置文件
@wrench/standard-version-config
的配置主要与 standard-version
相关,需要在根目录下创建 .versionrc.js
配置文件,内容如下:
-- -------------------- ---- ------- ----- ------------ - ------------------------------------------- ----- ------------- - - --- -------------- -------- ------------ ---- ---------------- ---------------- ------- ---- --- -- -------------- - ------------------ -------------- ------ -------------------
上述配置中的 wrenchOptions
对象,是针对 standard-version
的配置,它里面的各项参数可以根据自己的需要进行自定义。其中一些主要的参数说明如下:
updateTypes
:设置自动增加的版本号类型,默认为"patch"
。可选值:"major"、"minor"、"patch";tagPrefix
:打标签时的前缀,可选参数;commitMessage
:提交记录的模版。
使用
安装后,可以通过在代码库的根目录中运行以下命令(使用 yarn 或者 npm)从控制台调用:
yarn wrench-release npm run wrench-release
这个命令会生成下一个版本号,并自动根据 git 日志更新版本号,并自动执行打标签和提交更新操作。命令结束后,将自动出现具有标签和提交日志的新版本发布状态。
示例代码
下面我们使用 React 项目为例,演示如何使用 @wrench/standard-version-config
进行版本控制:
安装
@wrench/standard-version-config
包:npm install @wrench/standard-version-config --save-dev
在项目根目录下添加
.versionrc.js
配置文件,如下:-- -------------------- ---- ------- ----- ------------ - ------------------------------------------- ----- ------------- - - --- -------------- -------- ------------ ---- ---------------- ---------------- ------- ---- --- -- -------------- - ------------------ -------------- ------ -------------------
在
package.json
配置文件中添加脚本命令:"scripts": { ... "wrench-release": "standard-version --skip.tag --skip.commit --skip.changelog && git add package.json CHANGELOG.md && git commit -m \"chore(release): publish [skip ci]\" && git tag -f $(node -p -e 'require(\"./package.json\").version') -a -m \"chore(release): publish [skip ci]\" && git push origin main --follow-tags", ... }
运行命令发布新版本:
yarn wrench-release
此时会自动生成版本号,并自动更新指定位置的版本号,然后在终端上打印出
VERSION X.X.X
。其他查看版本号相关命令:
yarn version yarn version --patch yarn version --minor yarn version --major
其他查看版本号相关命令1:
yarn version yarn version --patch yarn version --minor yarn version --major
以上就是使用 @wrench/standard-version-config
进行前端项目版本控制的详细方法和步骤。在使用过程中,如果遇到任何问题,可以参考相关文档进行解决。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600673defb81d47349e53bbb