项目更新日志自动生成(简易版本)
发布: 2019-11-01 16:01:11标签: 前端开发
一、全局环境准备git cz
和conventional-changelog
01# 安装成功之后,会有两个全局的和02npm install -g commitizen03echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc04npm install -g conventional-changelog-cli
复制代码二、规范git提交
(1) 使用git cz
代替git commit
,按提交代码
(2) 手动提交类似:Type(文件或者模块): 提交信息
的commit记录
(3) type类型包括:
- feat(新功能)
- fix(修补bug)
- perf(优化Performance)
- style(格式化)
- docs(文档)
- refactor(重构)
- build(构建改动)
- ci
- test
三、生自动生成更新日志
(1) 修改package.json
01{02 "scripts": {03 "version": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md"04 }05}
复制代码加入之后,在执行npm verson [patch]
或者npm run version
的时候自动生成日志
(2) 支持一个git仓库多个项目(修改每个项目中的package,指定生成当前目录下的日志)
01{02 "scripts": {03 "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 --commit-path '.'"04 }05}
复制代码四、检查提交规范
(1) 安装 yorkie
01yarn add yorkie -D
复制代码(2) 使用下边正则,根据需要修改,具体查看 vue/scripts/verify-commit-msg.js
01const commitRE = /^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types|build)(\(.+\))?: .{1,50}/
复制代码