ci: create commit-lint.yml (#1280)

* ci: create commit-lint github action

* ci: move git-env script to run on make prepare

Signed-off-by: Darren Murray <[email protected]>

---------

Signed-off-by: Darren Murray <[email protected]>

Author: dmurray-lacework

.github/workflows/commit-lint.yml

@@ -0,0 +1,24 @@
+name: Commit Message Lint
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  gitlint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+
+      - name: Install gitlint
+        shell: bash
+        run: |
+          python -m pip install gitlint
+
+      - name: Run gitlint
+        shell: bash
+        run: |
+          gitlint --commit ${{ github.event.pull_request.head.sha }} --debug

.gitlint

@@ -0,0 +1,17 @@
+# Commit msg lint config
+
+## https://jorisroovers.com/gitlint/latest/ignoring_commits/
+## https://jorisroovers.com/gitlint/latest/rules/builtin_rules/
+
+[general]
+regex-style-search=true
+ignore=B1,B6
+
+# Ensure every title starts with a user-story identifier like US123
+[title-match-regex]
+regex="feat(:|\(.*\):)|fix(:|\(.*\):)|style(:|\(.*\):)|refactor(:|\(.*\):)|test(:|\(.*\):)|docs(:|\(.*\):)|chore(:|\(.*\):)|build(:|\(.*\):)|ci(:|\(.*\):)|perf(:|\(.*\):)|metric(:|\(.*\):)|misc(:|\(.*\):)|release:"gi
+
+# Ignore Release commits
+[ignore-by-title]
+regex=Release(.*)
+ignore=all

Makefile

@@ -40,7 +40,7 @@ help:
 	@echo "-------------------------------------------------------------------"
 
 .PHONY: prepare
-prepare: install-tools go-vendor ## Initialize the go environment
+prepare: git-env install-tools go-vendor ## Initialize the go environment
 
 .PHONY: test
 test: prepare ## Run all go-sdk tests

scripts/githooks/commit-msg

@@ -2,15 +2,14 @@
 readonly project_name=go-sdk
 readonly commit_tags="feat(:|\(.*\):)|fix(:|\(.*\):)|style(:|\(.*\):)|refactor(:|\(.*\):)|test(:|\(.*\):)|docs(:|\(.*\):)|chore(:|\(.*\):)|build(:|\(.*\):)|ci(:|\(.*\):)|perf(:|\(.*\):)|metric(:|\(.*\):)|misc(:|\(.*\):)|release:"
 readonly commit_message=`cat $1`
-readonly blah="Please enter the commit message for your changes"
 
 validate_commit_message(){
         if ! [[ $commit_message =~ $commit_tags ]]; then
             invalid_message
             exit 1
         fi
             log "Commit message is valid"
-} 
+}
 
 invalid_message(){
     log "Invalid commit message"