在项目开发中,我们通常都会使用 git 进行版本管理,随着项目的发展,版本也不可避免地会不断迭代。为了更好地管理版本,我们需要遵循一定的规范,并且在每个版本发布前都要写好 changelog。但是手写 changelog 一方面费时费力,另一方面容易出错。这时候,conventional-changelog-vue-material
出现了。
什么是 conventional-changelog-vue-material
?
conventional-changelog-vue-material
是一种自动化版本控制工具,它可以依据项目的 commit message 自动生成 changelog。使用这个工具可以省去手动写 changelog 的时间,更重要的是它能够保证 changelog 的规范性,从而方便团队的协作。
如何使用 conventional-changelog-vue-material
?
接下来,我们将通过以下几个步骤介绍如何使用 conventional-changelog-vue-material
。
安装
使用 npm 安装 conventional-changelog-vue-material
:
npm i -D conventional-changelog-vue-material
配置
在项目根目录下创建一个 .conventional-changelog.js
文件,然后配置一些相关信息。例如:
module.exports = { preset: 'vue-material', releaseCount: 0, ignoreCommitsWith: [ 'chore', 'style', 'docs', 'refactor', 'test', 'fix' ] }
上面的配置中,我们指定了 preset
为 vue-material
,表示我们是要生成 Vue Material 框架库的 changelog,同时 releaseCount
指定生成 changelog 的版本数量,ignoreCommitsWith
参数表示忽略某些 commit 类型,例如 chore
, style
, docs
, refactor
, test
, fix
等。
同时,我们在 package.json
中配置 scripts
,例如:
"version": "0.0.1", "scripts": { "changelog": "conventional-changelog -p vue-material -i CHANGELOG.md -s" }
生成 changelog
在命令行中输入如下命令:
npm run changelog
这时会在项目根目录下生成 CHANGELOG.md
文件,并且自动生成 changelog。这个文件可以放在代码仓库中进行版本控制。
示例代码
我们可以通过自己的项目来尝试一下 conventional-changelog-vue-material
。首先创建一个 Vue 项目:
vue create my-project
接着,安装 conventional-changelog-vue-material
:
npm i -D conventional-changelog-vue-material
在项目根目录下创建 .conventional-changelog.js
文件:
module.exports = { preset: 'vue-material', releaseCount: 0, ignoreCommitsWith: [ 'chore', 'style', 'docs', 'refactor', 'test', 'fix' ], }
然后在 package.json
中添加以下 scripts
:
"scripts": { "changelog": "conventional-changelog -p vue-material -i CHANGELOG.md -s" }
接下来,输入命令生成 changelog:
npm run changelog
这时,我们就可以在 CHANGELOG.md
文件中看到自动生成的 changelog。
总之,通过使用 conventional-changelog-vue-material
可以让我们更方便地管理版本,提高协作效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedd602bb4e78292a6fb875