版本自动化及CHANGELOG生成
使用工具conventional-changelog进行CHANGELOG
文件的自动生成
安装
全局安装:
$ npm install -g conventional-changelog-cli
使用
基本使用命令如下:
$ conventional-changelog -p angular -i CHANGELOG.md -s
- 参数
-p
指定提交信息的规范,有以下选择:angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint
- 参数
-i
指定读取CHANGELOG
内容的文件 - 参数
-s
表示将新生成的CHANGELOG
输出到-i
指定的文件中
上述命令将基于上次tag
版本后的变更内容添加到CHANGELOG.md
文件中,CHANGELOG.md
之前的内容不会消失
如果想要重新生成所有版本完整的CHANGELOG
内容,使用以下命令:
$ conventional-changelog -p angular -i CHANGELOG.md -s -r 0
- 参数
-r
默认为1
,设为0
将重新生成所有版本的变更信息
快捷方式
在工程package.json
中加入以下脚本
{
"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
}
}
运行如下命令即可生成1CHANGELOG
$ npm run changelog