规范commit提交与生成changelog

1,195 阅读1分钟

使用commit-changelog以后,git commit 的提交内容和格式会被限制,同时运行npm run changelog将其生成到changelog中

vue项目中changelog,是否也想让自己的项目拥有好的changelog

先安装

npm install commit-changelog -g

再在项目中进行初始化

commitChangelog init

使用示例

npm run changelog

使用效果

实现原理

yorkie 是Vue作者尤雨溪fork了husky并做了一些修改的工具,改善了一些使用体验

validate-commit-msg 检查你的 commit-message 规范

conventional-changelog 是可以根据项目的commit 和 metadata信息自动生成 changelogs 和 release notes的工具

cz-conventional-changelog 可以按照固定格式进行交互式生成规范的git提交说明


Github项目地址

github.com/dericktang/…

遇到问题提个Issues吧

github.com/dericktang/…