Python Table Manners - Commitizen: 規格化 commit message


接續著前一篇的 pre-commit 繼續談 git 相關的工具
這篇來聊聊如何透過 commitizen 規範 commit message
還有我們能拿規範過的 commit message 做什麼

為什麼要好好寫 commit message

no-good-commit

如果不好好寫有意義的 commit message,每次都只用 "update" 當訊息
當你下了 git log 指令,就會看到一堆 "update"
然後哪天系統出錯的時候,你也會不知道要回朔到哪一個版本

bad-commit
(from hackjutsu/bad-commit-example)

撰寫好的 commit message,除了讓未來的自己知道自己在幹嘛
也能讓團隊之間的溝通更順利

  • 送 Pull Request / Merge Request 時,reviewers 能更快速地知道增加了哪些功能
  • 新進人員可以從過往的 commit message 找到整個專案發展的脈絡,更容易上手專案

Commitizen

除了提供的 commit message 撰寫建議和規範 (👉 Writing commits
commitizen 更進一步提供互動式介面,讓使用者可以夠輕鬆地產生符合規範的 commit message

同時也整合了前一篇所提到的 pre-commit hook,避免使用者將不符合規範的 commit message 寫入

除了採用來自 Angular 社群的 Conventional Commits (約定式提交) 外, commitizen 提供了高度的客製化,讓每個團隊或專案都可以依照自己的需求,撰寫相對應的規範

規範了 commit message 後,除了增加可讀性增加外,也讓訊息有可以被解析做其他運用
e.g., 提升版本號, 產生更新日誌

安裝與設定 Commitizen

跟 invoke 一樣,我會把 commitizen 同時安裝在系統和虛擬環境

安裝在虛擬環境主要是為了能在 CI/CD 伺服器上自動升版

# 安裝 commitizen 到系統
pipx install commitizen

# 安裝 commitizen 到虛擬環境中
pipenv install commitizen --dev

在專案中第一次使用 commitizen 可以使用初始化指令來完成基本的設定

cz init

一開始會問要將設定寫在哪個檔案內
ini 格式的設定(i.e., .cz, setup.cfg, .cz.cfg) 在 2.0 之後將不再支援
因此建議選擇 pyproject.toml.cz.toml

cz-init-1

接著會選擇一套 commit 規範
預設有三種,這裡先以 cz_conventional_commits 為例

cz-init-2

再來回詢問最新的 git tag 來確認是否為最新的版本號
如果不是,就會列出 git tag 所有的結果
如果完全沒有用過 git tag,預設會是 0.0.1

cz-init-3

最後會詢問版本的格式要是如何
常用的格式有 $version (e.g., 1.0.0) 或 v$version (e.g., v1.0.0)

cz-init-4

完成後就會將相對應的內容加入到設定檔

[tool.commitizen]
name = "cz_conventional_commits"
version = "1.0.2"
tag_format = "$version"

使用 Commitizen

# 使用 commitizen 做 commit
# (也可以用簡短版的 cz c)
cz commit

cz_conventional_commits 這套規則為例
會先詢問這次的 commit 做了哪一種改動

commitizen-1

接著會要求輸入這次改動各項細節

  • Scope: 改動範圍
  • Subject: 簡短敘述這次的改動
  • Is this a BREAKING CHANGE?: 這是否是一個重大改動
  • Body: 詳細敘述這次的改動
  • Footer: 參考,通常可以將 Issue 的編號寫在這

commitizen-2-w1024

回答完,就會產生 commit message feat(tasks): add `inv git.commit`

強制檢查 commit message

剛開始引入 commitizen 時,可能會常常忘記要使用它來做 commit
這時候就能使用到前一篇提到的 pre-commit

我在 commitizen 中有加入 .pre-commit-hooks.yaml
因此只要在專案的 .pre-commit-config.yaml 加入以下這段

- repos
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v1.17.0
    hooks:
      - id: commitizen
        stages: [commit-msg]

並透過 pre-commit 設定 commit-msg 階段的 git hook

pipenv run pre-commit install -t commit-msg

在 commit 執行完,要進訊息寫入前
git 會執行 cz check 來確認輸入的訊息是否符合規範
如果不符合規範就會拒絕這次的 commit

需要注意的是檢查會在產生 commit message 後才能執行
因此要設定 commit-msg 階段的 git hook (i.e., .git/hooks/commit-msg
如果只下 pipenv run pre-commit install 是不會成功的

接著就可以開始談,能將這些 commit message 做什麼應用了

自動提升版本號

與 commit message 規範可以做客製化不同
commitizen 目前並沒有提供不同版本表示方式的客製化
一律都會遵守 Semantic Version (語意化版本)
這種版本號採用 MAJOR.MINOR.PATCH (e.g., 1.10.20) 的格式

  • MAJOR: 重大改動,不向後相容
  • MINOR: 新增功能,必須向後相容
  • PATCH: 修正功能,必須向後相容

以 commitizen 預設使用的 cz_conventional_commits 來說,相對應的 commit 種類和應該提升的版本號如下

  • MAJOR: BREAKING CHANGE (每次 commit 都會問的,這次是否為重大改動)
  • MINOR: feat
  • PATCH: fix, refactor, perf

p.s. conventional commit 可以有很多種延伸,這裡指的只是 commitizen 採用的版本

每次提升版本號只會提升 1 ,而且以最前面的為主
e.g., 要 merge 回 master 的改動中出現 BREAKING CHANGE,不管其他有多少 feat 或 fix ,都只會讓 MAJOR 提升 1

目前只有 cz_conventional_commits 有預設的版本對應
如果為 cz_jira, cz_customize 或自己客製化規則加上提升版本的功能,可以參考commitizen 文件中 customization ,並加上 bump_pattern(比對 commit 是哪個種類) 和 bump_map (哪個種類的 commit 要提升哪個版本號)

稍微解釋了一下提升版本的規則,接下來要來講該如何使用了

cz bump

第一次提升版本的時候,會先確認目前在設定檔 (e.g., pyproject.toml)中的版本是否已經有相對應的 git tag

如果沒有則會確認這是否是第一次為這個專案加上 git tag

Tag v0.0.1 could not be found.
Possible causes:
- version in configuration is not the current version
- tag_format is missing, check them using 'git tag --list'

? Is this the first tag created?  (Y/n)

如果想跳過這個確認可以在後面加上參數 --yes

cz bump --yes

接著 commitizen 就會新增一個相對應的 git tag 和更新設定檔中的版本號
因為要將設定檔中的改動儲存, commitizen 這時會再新增一個 commit
(e.g., bump: version 0.0.1 → 0.0.2)

除了設定檔中的版本號外,有時候專案本身也有其他地方會使用到版本號
如果每次透過 commitizen 提升版本號後,還要手動更新其他部分,就失去了自動的好處了
所以 commitizen 另外提供了 version_files 這個設定,將需要改動的檔案也寫進來
commitizen 提升版本號時,就會一併更新檔案的內容
(Read More 👉 bump

透過 cz bump 指令雖然可以省下很多步驟
但更好的做法是將自動升版加入到加入到持續整合(Continuous Integration)
在 git repo 上將分支 merge 到 master 時,自動提升版本號
這部分因為會牽涉到各個不同平台的做法,不會敘述太多
這裡附上 commitizen 文件中 Github ActionsGitlab CI 的做法

客製化 commit 規範

目前 commitizen 提供兩種方式

  1. 直接在設定檔設定 → 適合只需要改動問題,不需要使用到複雜的功能
  2. 將 commit 規範寫成 Python 套件發佈 → 適合需要加入複雜的驗證

直接在設定檔設定

這種做法只支援 toml 格式的設定檔 (i.e., pyproject.toml, .cz.toml

首先必須先將 name 指定到 cz_customize 這套 commit 規範

[tool.commitizen]
name = "cz_customize"

再來要設定下面的欄位
其中最重要的只有 message_template(支援Jinja
"{{change_type}}:{% if show_message %} {{message}}{% endif %}" 這個例子來說
需要 change_type, show_message, message 三個變數來產生 commit message

[tool.commitizen.customize]
message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}"
example = "feature: this feature eanable customize through config file"
schema = "<type>: <body>"
bump_pattern = "^(break|new|fix|hotfix)"
bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"}
info_path = "cz_customize_info.txt"
info = """
This is customized info
"""

變數要在 [[tool.commitizen.customize.questions]] 的區段作定義
這裡使用到的是套件 questionary

  • name: 必須跟前面 message_template 定義的一模一樣,而且裡面用到的變數都要有對應的問題能取得值
  • message: 顯示給使用者的問題
  • typequestionary 中的問題型態
  • 其他欄位 (e.g., choice) 則是靠 type 來決定是否需要
[[tool.commitizen.customize.questions]]
type = "list"
name = "change_type"
choices = ["feature", "bug fix"]
message = "Select the type of change you are committing"

[[tool.commitizen.customize.questions]]
type = "input"
name = "message"
message = "Body."

[[tool.commitizen.customize.questions]]
type = "confirm"
name = "show_message"
message = "Do you want to add body message in commit?"

設定完之後,再使用 cz commit 就可以看到客製化過後的問題了
customize

將 commit 規範寫成 Python 套件發佈

這個做法比較複雜,也比較不常會用到,所以我只會概略地講
(Read More 👉 Customization

我已經先將套件的架構驟寫成一個 cookiecutter 範本
透過以下指令,可以進入 cookiecutter 的互動式介面,並初始化專案

cookiecutter gh:Lee-W/commitizen_cz_template

最主要需要實作的函式有 questions, message
實作完成後,必須要在要使用這個 commit 規範的環境安裝這個套件
安裝之後會在 cz ls 看到這個新的 commit 規範
在設定檔中設定 name 或在指令列加上參數 -n name (e.g., cz -n cz_test commit) 就可以開始使用

自動產生更新日誌(Changelog)

commitizen 另外也支援產生 keep a changelog 格式的更新日誌
不過還沒被 merge 到 master 內
這個功能現在也還只是剛實作一個初版,應該會有一些問題
有興趣可以到 command-changelog 這個 branch 玩玩看,一起來除錯(?)

產生更新日誌(預設會取代 CHANGELOG.md

cz changelog

參數

  • --dry-run: 將更新日誌的內容輸出到終端機,不更新到檔案
  • --file-name FILE_NAME: 指定更新日誌名稱
  • --start-rev START_REV: 更新日誌開始的點(結束的點為目前所在的 commit)

其他 commitizen 指令和常用參數

  • cz bump: 提升版本號
    • --dry-run: 將提升版本號的訊息輸出到終端機,不會實際產生 tag 和改變檔案
    • --increment {MAJOR,MINOR,PATCH}: 提升特定版本號
  • cz -n NAME [command]: 使用不同的 commit 規則 (e.g., cz -n cz_jira commit
  • cz version: 顯示版本
    • -p--project): 顯示專案版本
    • -c--commitizen): 顯示 commitizen 版本(預設)

關於 commitizen 的雜談

我在 Taipei.py 第一次試講 Python Table Manners 時
有一頁就提到了,雖然 Python 也有 commitizen 這個工具,但還不太成熟

commitizen is not mature

沒想到在 PyCon CA 的前一個禮拜我認真測試時
才發現其實 commitizen 已經很夠用了,該有的功能都有
只是我剛好都用一些奇怪的測試方式,測到一些 edge case
這時就覺得信奉 Python (???)的我,好像應該好好的介紹 Python 的工具
而不是 JavaScript 的 commitizen

i am the one who's not mature

於是我就在 PyCon CA 前一個禮拜,開始貢獻起 commitizen
把我遇到的 issues 都修了,就順便把投影片中相關的內容一起翻新了

貢獻的過程中也發現了很多還能再增加的新功能,於是就在 PyCon CA 2019 帶了這個專案去 Develop Sprint
第一次當 Sprint Leader 還蠻好玩的,也蠻有成就感的
(Read More 👉 PyCon CA 2019

為什麼不用 Java Script 的 commitizen 就好了

因為我是 Python 的開發者啊!!!

起初我也是從 Java Script 的版本開始使用 (畢竟兩個專案 star 的數量差了一百倍)
原本我就有寫好 commit message 的習慣
能有工具幫助我把這件事做得更好,當然就再好不過了

用了一段時間後,我開始覺得我明明都已經認真寫好 commit message 了
為什麼每次 Pull Request / Merge Request 還是花那麼多時間寫
是不是有什麼工具可以自動透過寫好的 commit 產生一些訊息?
再來就找到了 cz-conventional-changelog

cz-conventional-changelog 不能跟 cz-customizable 同時使用
(Read More 👉 Possible to use multiple adapters? #434

而且這些擴充常常要用到 package.json 來做設定
可是我就不是 Java Script 的專案,就不想加入這個檔案來設定啊 🤷‍♂️
所以才開始來找是不是有 Python 版本的替代方案
(Python 的 commitizen 支援的 toml (.cz.toml)是通用的格式,裡面 Python 相關的內容,適用於各語言)

持續貢獻

整體來說, commitizen 是一個讓我貢獻得很有成就感的專案
最主要的原因之一就是這是我想用的工具

貢獻的過程,也會很快就收到作者 Woile 的回饋
它也會用很友善的文字,讓我覺得貢獻 commitizen 所花的時間,是有受到重視的

friendly-response-1

friendly-response-2

除此之外, commitizen 測試覆蓋率很高,比較不需要怕改錯了會不會弄壞舊有的功能
程式碼風格上,透過 black 跟 flake8 來規範,讓程式碼閱讀起來輕鬆很多
在貢獻的過程中,也學到了不少很實用的工具(e.g., pre-commit, cookiecutter)

所以我說一起來貢獻 commitizen 吧 💪
我最近開始比較忙,有一段時間沒辦法積極地送 Pull Request 了 😢
但還是希望新功能能在 commitizen 上出現 🎉

Reference

#Python #Git #conventional commit
Python Table Manners
各種開發 Python 專案時用得到的工具們






Related Posts

# JavaScript Immutable ( 不可變 ) 概念

# JavaScript Immutable ( 不可變 ) 概念

如何使用 Python 和 Locust 進行 Load testing 入門教學

如何使用 Python 和 Locust 進行 Load testing 入門教學

MTR04_0702

MTR04_0702



Sponsored



Comments