前面和大家介绍了commitlint + Husky 规范 git commit 日志,提及了规范的 commit message 有助于团队其它人员 review,还可以有效的输出 CHANGELOG
,本文就是介绍如何输出 CHANGELOG.md
- 安装依赖
npm install conventional-changelog conventional-changelog-cli --save-dev
or
yarn add conventional-changelog conventional-changelog-cli --save-dev
- 添加脚本
修改 package.json 中 scripts 字段
{
"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
}
}
- 生成CHANGELOG.md文件
直接运行下面的命令即可
npm run changelog
如果type
为feat
、fix
、perf
、revert
,则该 commit 将肯定出现在 Change log 之中。其他情况(docs
、chore
、style
、refactor
、test
)由你决定,要不要放入 Change log,建议是不要。
注意,版本的log使用
npm version <newversion>
才会生成新的log,手动修改 package.json version 不会有新的版本log