BUG/MINOR: check if whole message is properly formatted

between subject and body of a message we need to have and empty line

Author: oktalz

.github/workflows/actions.yaml

@@ -5,20 +5,21 @@ jobs:
     name: Go lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
   go_build:
     name: Go build
     runs-on: ubuntu-latest
     needs: ["go_lint"]
     steps:
     - name: Check out code into the Go module directory
-      uses: actions/checkout@v2
-    - name: Set up Go 1.17
-      uses: actions/setup-go@v2
+      uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v4
       with:
-        go-version: 1.17
+        go-version-file: 'go.mod'
+        check-latest: true
       id: go
     - name: Get dependencies
       run: |
@@ -31,10 +32,12 @@ jobs:
     runs-on: ubuntu-latest
     needs: ["go_build"]
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-go@v2
+    - uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v4
       with:
-        go-version: 1.17
+        go-version-file: 'go.mod'
+        check-latest: true
       id: go
     - name: Get dependencies
       run: |
@@ -48,13 +51,14 @@ jobs:
     runs-on: ubuntu-latest
     needs: ["go_build"]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - name: Set up Go 1.17
-      uses: actions/setup-go@v2
+    - name: Set up Go
+      uses: actions/setup-go@v4
       with:
-        go-version: 1.17
+        go-version-file: 'go.mod'
+        check-latest: true
     - name: check-commit
       run: go build -o check && ./check
       env:

.github/workflows/build_on_trag.yaml

@@ -23,13 +23,13 @@ jobs:
       contents: read
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Build image
         run: docker build . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"
 
       - name: Log in to registry
-        # This is where you will update the PAT to GITHUB_TOKEN
+        # This is where you will update the PATH to GITHUB_TOKEN
         run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
 
       - name: Push image

check.go

@@ -5,7 +5,6 @@ import (
 	"encoding/hex"
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"path"
@@ -15,7 +14,7 @@ import (
 	"unicode"
 	"unicode/utf8"
 
-	"github.com/google/go-github/v35/github"
+	"github.com/google/go-github/v56/github"
 
 	"github.com/xanzy/go-gitlab"
 	"golang.org/x/oauth2"
@@ -244,7 +243,7 @@ func LoadCommitPolicy(filename string) (CommitPolicyConfig, error) {
 
 	var config string
 
-	if data, err := ioutil.ReadFile(filename); err != nil {
+	if data, err := os.ReadFile(filename); err != nil {
 		log.Printf("warning: using built-in fallback configuration with HAProxy defaults (%s)", err)
 
 		config = defaultConf
@@ -297,8 +296,18 @@ func getGithubCommitSubjects() ([]string, error) {
 
 		subjects := []string{}
 		for _, c := range commits {
-			l := strings.SplitN(c.Commit.GetMessage(), "\n", 2)
+			l := strings.SplitN(c.Commit.GetMessage(), "\n", 3)
+			hash := c.Commit.GetSHA()
+			if len(hash) > 8 {
+				hash = hash[:8]
+			}
+			if len(l) > 1 {
+				if l[1] != "" {
+					return nil, fmt.Errorf("empty line between subject and body is required: %s %s", hash, l[0])
+				}
+			}
 			if len(l) > 0 {
+				log.Printf("detected message %s from commit %s", l[0], hash)
 				subjects = append(subjects, l[0])
 			}
 		}
@@ -335,8 +344,15 @@ func getGitlabCommitSubjects() ([]string, error) {
 
 	subjects := []string{}
 	for _, c := range commits {
-		l := strings.SplitN(c.Message, "\n", 2)
+		l := strings.SplitN(c.Message, "\n", 3)
+		hash := c.ShortID
 		if len(l) > 0 {
+			if len(l) > 1 {
+				if l[1] != "" {
+					return nil, fmt.Errorf("empty line between subject and body is required: %s %s", hash, l[0])
+				}
+			}
+			log.Printf("detected message %s from commit %s", l[0], hash)
 			subjects = append(subjects, l[0])
 		}
 	}

go.mod

@@ -1,10 +1,21 @@
 module check-commit
 
-go 1.15
+go 1.21
 
 require (
-	github.com/google/go-github/v35 v35.0.0
-	github.com/xanzy/go-gitlab v0.48.0
-	golang.org/x/oauth2 v0.0.0-20210413134643-5e61552d6c78
+	github.com/google/go-github/v56 v56.0.0
+	github.com/xanzy/go-gitlab v0.93.2
+	golang.org/x/oauth2 v0.13.0
 	gopkg.in/yaml.v2 v2.4.0
 )
+
+require (
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
+	github.com/hashicorp/go-retryablehttp v0.7.2 // indirect
+	golang.org/x/net v0.16.0 // indirect
+	golang.org/x/time v0.3.0 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
+)