歡迎光臨
每天分享高質量文章

運維開發:你可能會忽略的 Git 提交規範

來源:Python運維圈

ID:devops_circle

一、為什麼需要規範?

無規矩不成方圓,編程也一樣。

如果你有一個專案,從始至終都是自己寫,那麼你想怎麼寫都可以,沒有人可以干預你。可是如果在團隊協作中,大家都張揚個性,那麼代碼將會是一團糟,好好的專案就被糟踐了。不管是開發還是日後維護,都將是災難。

這時候,有人提出了何不統一標準,大家都按照這個標準來。於是 ESLint,JSHint 等代碼工具如雨後春筍般涌現,成為了專案構建的必備良品。

Git Commit 規範可能並沒有那麼誇張,但如果你在版本回退的時候看到一大段糟心的 Commit,恐怕會懊惱不已吧。所以,嚴格遵守規範,利人利己。

二、具體規則

先來看看公式:

():  

type

  • 用於說明 commit 的類別,只允許使用下麵7個標識。

  • feat:新功能(feature)

  • fix:修補

  • bugdocs:文件(documentation)

  • style: 格式(不影響代碼運行的變動)

  • refactor:重構(即不是新增功能,也不是修改bug的代碼變動)

  • test:增加測試

  • chore:構建過程或輔助工具的變動

scope

用於說明 commit 影響的範圍,比如資料層、控制層、視圖層等等,視專案不同而不同。

subject

是 commit 目的的簡短描述,不超過50個字符。

  • 以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes

  • 第一個字母小寫

  • 結尾不加句號(.)

三、異常處理

我們先來看看這個異常提醒:

INVALID COMMIT MSG: does not match “(): ” ! 

jartto:fix bug 

這裡之所以報出這個警告,是因為我的提交出現了兩個問題:

  • 其一,使用了規範外的關鍵字;

  • 其二,很細節的問題,jartto:後少了空格;

這時候我才回憶起來,當時提交一直失敗,情急之下直接強制提交,所以以後的提交都會抱出這個異常。大致意思就是:

你的之前的 Commit 不合格~你的之前的 Commit 不合格~你的之前的 Commit 不合格

這時候就很煩了,我們只能去將之前的錯誤修正,那麼如何操作呢?

四、如何修改之前的 commit 信息?

其實並不複雜,我們只需要這樣做:

1、將當前分支無關的工作狀態進行暫存

git stash 

2、將 HEAD 移動到需要修改的 commit 上

git rebase 9633cf0919^ –interactive

3、找到需要修改的 commit ,將首行的 pick 改成 edit

4、開始著手解決你的 bug

5、 git add 將改動檔案添加到暫存

6、 git commit –amend 追加改動到提交

7、git rebase –continue 移動 HEAD 回最新的 commit

8、恢復之前的工作狀態

git stash pop

大功告成,是不是想把整個 Commit 都修改一遍,逃~

五、專案中使用

這時候問題又來了,為什麼我提交的時候會有警告,這個又是如何做到的呢?

這時候,我們需要一款 Node 插件 validate-commit-msg 來檢查專案中 Commit message 是否規範。

1.首先,安裝插件:

npm install –save-dev validate-commit-msg 

2.使用方式一,建立 .vcmrc 檔案:

  “types”: [“feat”, “fix”, “docs”, “style”, “refactor”, “perf”, “test”, “build”, “ci”, “chore”, “revert”], 

  “scope”: { 

    “required”: false, 

    “allowed”: [“*”], 

    “validate”: false, 

    “multiple”: false 

  }, 

  “warnOnFail”: false, 

  “maxSubjectLength”: 100, 

  “subjectPattern”: “.+”, 

  “subjectPatternErrorMsg”: “subject does not match subject pattern!”, 

  “helpMessage”: “”, 

  “autoFix”: false 

3.使用方式二:寫入 package.json

  “config”: { 

    “validate-commit-msg”: { 

      /* your config here */ 

    } 

  } 

}

4.可是我們如果想自動使用 ghooks 鉤子函式呢?

  … 

  “config”: { 

    “ghooks”: { 

      “pre-commit”: “gulp lint”, 

      “commit-msg”: “validate-commit-msg”, 

      “pre-push”: “make test”, 

      “post-merge”: “npm install”, 

      “post-rewrite”: “npm install”, 

      … 

    } 

  } 

  … 

}

在 ghooks 中我們可以做很多事情,當然不只是 validate-commit-msg 哦。

更多細節請參考:validate-commit-msg

六、Commit 規範的作用

  • 提供更多的信息,方便排查與回退;

  • 過濾關鍵字,迅速定位;

  • 方便生成文件;

七、生成 Change log

正如上文提到的生成文件,如果我們的提交都按照規範的話,那就很簡單了。生成的文件包括以下三個部分:

  • New features

  • Bug fixes

  • Breaking changes.

每個部分都會羅列相關的 commit ,並且有指向這些 commit 的鏈接。當然,生成的文件允許手動修改,所以發佈前,你還可以添加其他內容。

這裡需要使用工具 Conventional Changelog 生成 Change log :

npm install -g conventional-changelog 

cd jartto-domo 

conventional-changelog -p angular -i CHANGELOG.md -w

為了方便使用,可以將其寫入 package.json 的 scripts 欄位。

  “scripts”: { 

    “changelog”: “conventional-changelog -p angular -i CHANGELOG.md -w -r 0” 

  } 

}

這樣,使用起來就很簡單了:

 npm run changelog

到這裡,我們所有的問題都搞明白了,? Cheers~

八、總結

看完文章,你還會如此放蕩不羈嗎?你還會隨心所欲的編寫 Commit 嗎?你還會如此 git commit -m “hello world”提交嗎?

答案是否定的,因為使用了鉤子函式,你沒有機會了,否則將是無窮無盡的恢復 Commit。這倒可以養成良好的提交習慣~~

《Linux雲計算及運維架構師高薪實戰班》2018年08月27日即將開課中,120天衝擊Linux運維年薪30萬,改變速約~~~~

    *宣告:推送內容及圖片來源於網絡,部分內容會有所改動,版權歸原作者所有,如來源信息有誤或侵犯權益,請聯繫我們刪除或授權事宜。

    – END –


    更多Linux好文請點擊【閱讀原文】

    ↓↓↓

    赞(0)

    分享創造快樂