build: Add check for commit message format

.github/workflows/main.yaml

@@ -21,7 +21,7 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v1
       with:
-        fetch-depth: 1
+        fetch-depth: 0
     - name: Test
       run: |
         scripts/alpine-setup.sh

Makefile

@@ -98,7 +98,7 @@ $(RELEASE_DIR)/%-$(RELEASE_SUFFIX): $(PACKED_DIR)/%-$(BIN_ARCH)
 	$(TAR) -cvz --transform 's,$(PACKED_DIR)/$(*)-$(BIN_ARCH),$(*),gi' -f "$@" "$<"
 
 ## Run Go tests
-test: generate test-fmt
+test: generate test-fmt test-git
 	go test -coverprofile fmtcoverage.html ./...
 .PHONY: test
 
@@ -108,6 +108,11 @@ test-fmt: generate
 	test -z "$$(go fmt ./...)"
 .PHONY: test-fmt
 
+## Check git commits formatting
+test-git:
+	./scripts/git-check-commits.sh
+.PHONY: test-git
+
 ## Clean build artifacts
 clean:
 	rm -rf $(GENERATE_DIR)

README.md

@@ -148,6 +148,36 @@ release-artifacts              Create release artifacts
 clean                          Clean build artifacts
 ```
 
+### Commit messages
+
+We enforce simple version of [Conventional Commits][cc] in the form:
+
+```
+<type>: <summary>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Where type is one of:
+- **build** - Affects build and/or build system
+- **chore** - Other non-functional changes
+- **ci** - Affects CI (e.g. GitHub actions)
+- **dep** - Dependency update
+- **docs** - Documentation only change
+- **feat** - A new feature
+- **fix** - A bug fix
+- **ref** - Code refactoring without functinality change
+- **style** - Formatting changes
+- **test** - Adding/changing tests
+
+[cc]: https://www.conventionalcommits.org/
+
+Use imperative, present tense (Add, not ~Added~), capitalize first letter of
+summary, no dot at the and. The body and footer are optional. Relevant GitHub
+issues should be referenced in the footer in the form `Fixes #123, fixes #456`.
+
 ## Issues and Contributions
 
 Please open any issues and/or PRs against github.com/doitintl/kube-no-trouble repository.

scripts/git-check-commits.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env sh
+# Set strict error checking
+set -emou pipefail
+
+BASE_REF="origin/master"
+COMMIT_TYPES="build|chore|ci|dep|docs|feat|fix|ref|style|test"
+COMMIT_REGEXP="^(${COMMIT_TYPES}): [A-Z]+.{5,}[^.]$"
+
+
+COMMITS_COUNT="$(git log --oneline --no-merges "${BASE_REF}..HEAD" | wc -l)"
+
+echo "- Checking commit messages: ${COMMITS_COUNT} commits"
+
+BAD_COMMITS="$(git log --oneline --no-merges -E --invert-grep --grep="${COMMIT_REGEXP}" "${BASE_REF}..HEAD")"
+if [ -n "${BAD_COMMITS}" ]; then
+  echo "${BAD_COMMITS}"
+  echo "Error: commit messages do no confirm to required format: ${COMMIT_REGEXP}"
+  exit 1
+fi