使用angular + commitizen + cz-conventional-changelog 來規(guī)范git commit
目的
- 統(tǒng)一團隊Git commit日志標(biāo)準(zhǔn)诽嘉，便于后續(xù)代碼review秽晚，版本發(fā)布以及日志自動化生成等等偎窘。
- 統(tǒng)一團隊的Git工作流毡惜，包括分支使用昼牛、tag規(guī)范祈噪、issue等
Git commit日志參考案例
參考鏈接：
總體方案
image
Git commit日志基本規(guī)范
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
對格式的說明如下：
- type代表某次提交的類型粥鞋，比如是修復(fù)一個bug還是增加一個新的feature。所有的type類型如下：
- feat： 新增feature
- fix: 修復(fù)bug
- docs: 僅僅修改了文檔裕膀，比如README, CHANGELOG, CONTRIBUTE等等
- style: 僅僅修改了空格员串、格式縮進、都好等等昼扛，不改變代碼邏輯
- refactor: 代碼重構(gòu)寸齐，沒有加新功能或者修復(fù)bug
- perf: 優(yōu)化相關(guān)，比如提升性能抄谐、體驗
- test: 測試用例渺鹦，包括單元測試、集成測試等
- chore: 改變構(gòu)建流程斯稳、或者增加依賴庫、工具等
- revert: 回滾到上一個版本
格式要求：
# 標(biāo)題行：50個字符以內(nèi)迹恐，描述主要變更內(nèi)容
#
# 主體內(nèi)容：更詳細(xì)的說明文本挣惰，建議72個字符以內(nèi)。 需要描述的信息包括:
#
# * 為什么這個變更是必須的? 它可能是用來修復(fù)一個bug殴边，增加一個feature憎茂，提升性能、可靠性锤岸、穩(wěn)定性等等
# * 他如何解決這個問題? 具體描述解決問題的步驟
# * 是否存在副作用竖幔、風(fēng)險?
#
# 尾部：如果需要的化可以添加一個鏈接到issue地址或者其它文檔，或者關(guān)閉某個issue是偷。
Git分支與版本發(fā)布規(guī)范
- 基本原則：master為保護分支拳氢，不直接在master上進行代碼修改和提交募逞。
- 開發(fā)日常需求或者項目時，從master分支上checkout一個feature分支進行開發(fā)或者bugfix分支進行bug修復(fù)馋评，功能測試完畢并且項目發(fā)布上線后放接，
將feature分支合并到主干master，并且打Tag發(fā)布留特，最后刪除開發(fā)分支纠脾。分支命名規(guī)范：- 分支版本命名規(guī)則：分支類型 _ 分支發(fā)布時間 _ 分支功能。比如：feature_20170401_fairy_flower
- 分支類型包括：feature蜕青、 bugfix苟蹈、refactor三種類型，即新功能開發(fā)右核、bug修復(fù)和代碼重構(gòu)
- 時間使用年月日進行命名慧脱，不足2位補0
- 分支功能命名使用snake case命名法，即下劃線命名蒙兰。
- Tag包括3位版本磷瘤，前綴使用v。比如v1.2.31搜变。Tag命名規(guī)范：
- 新功能開發(fā)使用第2位版本號采缚，bug修復(fù)使用第3位版本號
- 核心基礎(chǔ)庫或者Node中間價可以在大版本發(fā)布請使用灰度版本號，在版本后面加上后綴挠他，用中劃線分隔扳抽。alpha或者belta后面加上次數(shù)，即第幾次alpha：
- v2.0.0-alpha-1
- v2.0.0-belta-1
- 版本正式發(fā)布前需要生成changelog文檔殖侵，然后再發(fā)布上線贸呢。
如何接入？
接入?yún)⒖?a target="_blank" rel="nofollow">commit-message-test-project項目拢军。具體步驟如下：
- 第一步：在工程跟目錄下的package.json文件加入如下代碼所示的scripts和dependencies內(nèi)容楞陷，版本號為3位版本號。
{
"name": "application-name",
"version": "0.1.0",
"scripts": {
"commitmsg": "validate-commit-msg",
"commit": "git-cz ",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
},
"devDependencies": {
"commitizen": "^2.3.0",
"validate-commit-msg": "^2.11.1",
"conventional-changelog-cli": "^1.2.0",
"husky": "^0.13.1"
}
}
- 第二步：在工程根目錄新建.vcmrc文件茉唉，并且文件內(nèi)容為
{
"helpMessage": "\nPlease fix your commit message (and consider using https://www.npmjs.com/package/commitizen)\n",
"types": [
"feat",
"fix",
"docs",
"style",
"refactor",
"perf",
"test",
"chore",
"revert"
],
"warnOnFail": false,
"autoFix": false
}
接入后的Git commit操作流程
- 第一步：創(chuàng)建一個feature分支或者bugfix分支
$ git checkout -b feature_infinite_load # 切換到一個feature分支或者bug fix分支
- 第二步：將代碼提交到本地Git倉庫固蛾，并填寫符合要求的Commit message格式
$ git add .
$ git commit # 此處不要加任何參數(shù)，比如-m
如下圖所示：
image
- 第三步：將代碼同步到遠(yuǎn)程Git倉庫
$ git push origin feature_infinite_load # 將修改發(fā)布到遠(yuǎn)程倉庫
- 第四步：自動生成changelog度陆，并打Tag發(fā)布
$ npm run changelog # 使用npm script中的changlog命令直接從git元數(shù)據(jù)生成日志艾凯。
$ git tag v0.1.0
$ git push origin v0.1.0
安裝commitizen + cz-conventional-changelog
npm install -g commitizen
npm install -g cz-conventional-changelog
使用命令 git cz 替代 git commit，出現(xiàn)angular規(guī)范選擇懂傀，如圖：
[圖片上傳失敗...(image-c98018-1527586920607)]
生成輸出文檔使用命令：
npm run changelog
在當(dāng)前項目目錄中生成 CHANGELOG.md 文件趾诗，效果如圖：
changelog.jpg
