規範提交信息
1、全局安裝Commitizen
npm install -g commitizen
2、在項目根目錄下運行下面命令,使其支持angular的 Commit message 格式
commitizen init cz-conventional-changelog --save --save-exact
注意,–save-exact 相當於鎖定版本號
此時,package.json新增了這部分內容
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"devDependencies":{
"cz-conventional-changelog": "^3.1.0"
}
3、提交命令 (將git commit命令改爲git cz命令)
git add --all
git cz
延伸知識:
git add --all和git add . 的區別
- 1.x版本:
- git add --all可以提交未跟蹤、修改和刪除文件。
- git add .可以提交未跟蹤和修改文件,但是不處理刪除文件。
- 2.x版本兩者效果一致
類別
- feat:新功能(feature)
- fix:修補 bug
- docs:文檔(documentation)
- style: 格式(不影響代碼運行的變動)
- refactor:重構(即不是新增功能,也不是修改 bug 的代碼變動)
- test:增加測試
- chore:構建過程或輔助工具的變動
- revert:回滾代碼
檢測提交信息
- 安裝依賴
npm install ghooks validate-commit-msg --save-dev
- package.json配置
"config": {
"ghooks": {
"commit-msg": "validate-commit-msg"
}
}
自動生成CHANGELOG?
- 全局安裝
$ npm install conventional-changelog-cli -g
- package.json配置
"scripts":{
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
}
運行
npm run changelog