前言
在前端开发中,我们常常需要管理项目的版本号以及版本控制提交信息。常见的做法是使用 语义化版本控制规范,其中 conventional commits 是一种比较流行的规范,可以自动生成 changelog,方便版本发布和维护。
本文将介绍如何使用 npm 包 @0x-lerna-fork/conventional-commits 来帮助我们遵循 conventional commits 规范,生成标准的版本号和 changelog。
安装及使用
安装
使用 npm 安装 @0x-lerna-fork/conventional-commits:
npm install @0x-lerna-fork/conventional-commits --save-dev
配置
将以下配置添加到 package.json 中:
-- -------------------- ---- ------- - ---------- - --------- -------- -- --------- - ------------- - ------- ---------------------------------------------------- - - -
这里使用了 git-cz,它是一个类似于 git commit 命令的工具,但是它会帮助我们生成符合 conventional commits 规范的提交信息。
使用
使用 git-cz 进行提交:
npm run commit
按照提示编写提交信息即可。示例:
feat(nav): 新增导航栏组件 - 在 src/components/Nav.vue 中新增代码 - 完善组件文档和测试用例
此时可以看到,git-cz 帮助我们生成了符合 conventional commits 规范的提交信息,包括类型(feat)、影响范围(nav)、描述信息以及提交内容。
changelog 生成
在项目根目录下执行以下命令即可生成 changelog:
npx conventional-changelog -p angular -i CHANGELOG.md -s
其中 -p angular
指定了 changelog 的生成器,-i CHANGELOG.md
指定了 changelog 的输出路径,-s
表示从上一个版本的 tag 开始生成 changelog。
可将此命令添加到项目的发布脚本中,在每次发版时自动生成 changelog。
结语
使用 npm 包 @0x-lerna-fork/conventional-commits,我们可以方便地遵循 conventional commits 规范,自动生成符合规范的提交信息和 changelog,提高版本号管理和版本发布的效率和准确性。
同时,本文也介绍了如何使用 git-cz 和 conventional-changelog 工具来实现自动化 git 提交和 changelog 生成。
希望本文可以对大家的前端开发实践有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/205240