使用標(biāo)準(zhǔn)commit生成changelog標(biāo)準(zhǔn)化

對于一個多人團(tuán)隊來說,每次發(fā)布的日志更新和版本更新如果通過人肉完成,沒有統(tǒng)一的流程和規(guī)范,則容易造成混亂;尤其對于團(tuán)隊的新同學(xué),有時遇到緊急情況,則會更顯慌亂。這時候,用自動化工具再合適不過了!

conventional-changelog

onventional-changelog 可以根據(jù)項(xiàng)目的commit 自動生成 changelogs,并且和 standard-version 結(jié)合,可以自動完成生成version、打tag, 生成CHANGELOG等。

conventional-changelog 模塊

commitizen

全局安裝:npm install -g commitizen
或 本地安裝: npm install --save-dev commitizen

安裝適配器(cz-conventional-changelog)

全局安裝:npm install -g cz-conventional-changelo
在根目錄下添加.czrc,內(nèi)容為: { "path": "cz-conventional-changelog" }

或 本地安裝: npm install --save-dev cz-conventional-changelo
在package.json中添加配置:

"config": {
   "commitizen": {
     "path": "cz-conventional-changelog"
   }
 }

此時,提交commit過程如下:

  • git add .
  • git czcz
    標(biāo)準(zhǔn)提交提示

    第一行可看到 cz-cli@4.2.2, cz-conventional-changelog@3.3.0

conventional-changelog-cli

  • 安裝 npm install -g conventional-changelog-cli
  • 使用 conventional-changelog -p angular -i CHANGELOG.md -s
    該命令會在CHANGELOG.md文件頭部添加上次tag之后的commit信息
第一次changelog信息

版本號讀取的是package.json中的version

更多選項(xiàng)配置查看這里

則,一次changelog的過程如下:

  • 修改代碼
  • git add . / git cz
  • 修改package.json中的version
  • 運(yùn)行生成changelog命令,最好將命令集成到package.json的scripts中
  • 手動 Tag, Push等

standard-version

該工具幫助我們實(shí)現(xiàn)自動發(fā)布等功能,通常我們基于master發(fā)布時,流程如下:

  • git pull origin master
  • 前面的流程
  • 手動Tag, Push等

安裝

npm install -g standard-version
常用的命令如下:

自動化發(fā)布

會自動生成tag:
tag

則,基于以上工具,發(fā)布流程如下:

  • changes
  • git add . / git cz
  • npm run release


    scrpits

也可以指定發(fā)布的版本:


指定版本
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容