build: use hatch-regex-commit to auto create git tag

Author: WSH032

.pre-commit-config.yaml

@@ -48,4 +48,5 @@ repos:
     hooks:
       - id: commitlint
         stages: [commit-msg]
-        additional_dependencies: ["@commitlint/config-angular"]
+        # NOTE: the dependencies must consistent with `commitlint.config.js`
+        additional_dependencies: ["@commitlint/config-conventional"]

commitlint.config.js

@@ -1,3 +1,6 @@
-// https://commitlint.js.org/#/reference-configuration?id=shareable-configuration
+// refer to: https://commitlint.js.org/#/reference-configuration?id=shareable-configuration
 // Rule: https://karma-runner.github.io/6.4/dev/git-commit-msg.html
-module.exports = { extends: ['@commitlint/config-angular'] };
+// Rule: https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional
+
+// NOTE: the extends must consistent with `.pre-commit-config.yaml`
+module.exports = { extends: ['@commitlint/config-conventional'] };

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling >= 1.13.0"]
+requires = ["hatchling >= 1.13.0", "hatch-regex-commit"]
 build-backend = "hatchling.build"
 
 # https://hatch.pypa.io/latest/config/metadata/
@@ -59,7 +59,16 @@ Documentation = "https://WSH032.github.io/fastapi-proxy-lib/"
 
 
 [tool.hatch.version]
+# refer to: https://github.com/frankie567/hatch-regex-commit
+source = "regex_commit"
+commit_extra_args = ["-e"]
 path = "src/fastapi_proxy_lib/__init__.py"
+# NOTE: `chore` is required by commitlint
+commit_message = "chore(version): 🚀 bump version {current_version} → {new_version}"
+tag_message = "🚀 bump version {current_version} → {new_version}"
+# NOTE: `v` prefix is required by github `publish.yml` action
+tag_name = "v{new_version}"
+
 
 [tool.hatch.envs.default]
 path = ".venv" # for vscode auto selecting python interpreter