Merge pull request #7029 from okurz/feature/023_gitlint_git_commit_checks

feat: add gitlint for conventional commit checks

Author: mergify[bot]

.github/workflows/commit-message-checker.yml

@@ -1,15 +1,19 @@
 ---
-# https://github.com/marketplace/actions/gs-commit-message-checker
 name: 'Commit message check'
-# yamllint disable-line rule:truthy
 on:
   pull_request:
   push:
     branches:
-      - '!master'  # we must not fix commit messages when they already reached master
+      - '!master'
 
 jobs:
   check-commit-message:
-    secrets:
-      accessToken: "${{ secrets.GITHUB_TOKEN }}"
-    uses: os-autoinst/os-autoinst-common/.github/workflows/base-commit-message-checker.yml@master
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install gitlint
+        run: pip install gitlint-core
+      - name: Check commit messages
+        run: gitlint --commits origin/${{ github.base_ref }}..HEAD

.gitlint

@@ -0,0 +1,3 @@
+[general]
+contrib=contrib-title-conventional-commits
+ignore=body-min-length,body-is-missing

Makefile

@@ -344,7 +344,7 @@ public/favicon.ico: assets/images/logo.svg
 
 # all additional checks not called by prove
 .PHONY: test-checkstyle-standalone
-test-checkstyle-standalone: test-shellcheck test-yaml test-critic test-shfmt
+test-checkstyle-standalone: test-shellcheck test-yaml test-critic test-shfmt test-gitlint
 ifeq ($(CONTAINER_TEST),1)
 test-checkstyle-standalone: test-check-containers
 endif
@@ -373,6 +373,15 @@ test-shfmt:
 	@which shfmt >/dev/null 2>&1 || (echo "Command 'shfmt' not found, can not execute bash script syntax checks" && false)
 	shfmt -d -i 4 -bn -ci -sr $(shellfiles)
 
+.PHONY: test-gitlint
+test-gitlint:
+	@which gitlint >/dev/null 2>&1 || (echo "Command 'gitlint' not found, can not execute commit message checks. Install with 'python3-gitlint' (openSUSE) or 'pip install gitlint-core'" && false)
+	@if git rev-parse --verify master >/dev/null 2>&1 && [ "$$(git rev-parse HEAD)" != "$$(git rev-parse master)" ]; then \
+		gitlint --commits master..HEAD; \
+	else \
+		gitlint; \
+	fi
+
 .PHONY: test-check-containers
 test-check-containers:
 	tools/static_check_containers