如果你的所有 commit 都符合 Angular 格式,那么发布新版本时, Change log 就可以用脚本自动生成。
生成的文档包括以下三个部分。
- New features
- Bug fixes
- Breaking changes.
每个部分都会罗列相关的 commit ,并且有指向这些 commit 的链接。当然,生成的文档允许手动修改,所以发布前,你还可以添加其他内容。
安装conventional-changelog-cli
npm install -g conventional-changelog-cli
在scripts中添加下来两个命令:
{
"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"createlog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
}
}
运行npm run createlog
,会生成所有的log
运行npm run changelog
,会生成本次版本的log,不会覆盖以前的