Refactor GitHub Actions and Makefile for improved testing and linting workflow; add coverage reporting and update golangci-lint versioning

Author: Ravi Atluri

.github/workflows/test.yml

@@ -26,8 +26,14 @@ jobs:
         with:
           path: .bin
           key: ${{ runner.os }}-go1.25.x-${{ hashFiles('Makefile') }}
+      - name: Check
+        run: make check
       - name: Test
-        run: make ci
+        run: make test
+      - name: Coverage
+        run: make test-cov
+      - name: Generate coverage report in XML format
+        run: make test-xml
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
         with:

.golangci.yml

@@ -1,76 +1,123 @@
+version: "2"
+
 linters:
-  disable-all: true
+  default: none
+  # This list of linters is not a recommendation (same thing for all this configuration file).
+  # We intentionally use a limited set of linters.
   enable:
-    - errcheck
-    - staticcheck
-    - unused
-    - gosimple
-    - ineffassign
-    - stylecheck
-    - typecheck
-    - unconvert
     - bodyclose
+    - copyloopvar
+    - dogsled
     - dupl
+    - errcheck
+    - errorlint
+    - funlen
+    - gocheckcompilerdirectives
+    - gochecknoinits
     - goconst
+    - gocritic
     - gocyclo
-    - gofmt
+    - godox
+    - mnd
+    - goprintffuncname
+    - gosec
+    - govet
+    - intrange
+    - ineffassign
     - lll
     - misspell
     - nakedret
-    - exportloopref
-    - funlen
-    - nestif
-    - nlreturn
-    - prealloc
-    - rowserrcheck
+    - noctx
+    - nolintlint
+    - revive
+    - staticcheck
+    - testifylint
     - unconvert
     - unparam
+    - unused
     - whitespace
-    - wsl
+
+  settings:
+    govet:
+      enable-all: true
+      settings:
+        shadow:
+          strict: true
+    errcheck:
+      check-type-assertions: true
+    misspell:
+      locale: UK
+      ignore-words:
+        - initialized
+    funlen:
+      lines: 80
+      statements: 40
+    gci:
+      sections:
+        - standard
+        - default
+        - blank
+        - dot
+        - alias
+      custom-order: true
+    revive:
+      rules:
+        - name: package-comments
+          disabled: true
+  exclusions:
+    generated: lax
+    rules:
+      - path: _test\.go
+        linters:
+          - dupl
+          - gosec
+          - wsl
+          - lll
+          - funlen
+          - nlreturn
+          - unused
+      - path: _test\.go
+        text: "^Error return value is not checked$"
+        linters:
+          - errcheck
+      - text: "^SA1019:.* is deprecated:"
+        linters:
+          - staticcheck
+      - text: "declaration of \"(err|ctx)\" shadows declaration at"
+        linters:
+          - govet
+      - text: "return value of `tx.Rollback` is not checked"
+        linters:
+          - errcheck
+
+formatters:
+  enable:
+    - gofmt
+    - gci
+
+  settings:
+    gofmt:
+      simplify: true
+      rewrite-rules:
+        - pattern: 'interface{}'
+          replacement: 'any'
+        - pattern: 'a[b:len(a)]'
+          replacement: 'a[b:]'
+    gci:
+      sections:
+        - standard
+        - default
+        - blank
+        - dot
+        - alias
+      custom-order: true
+
 run:
   skip-dirs:
     - bin
   skip-files:
     - .*mock.*\.go$
     - version.go
-    - .*\_test\.go$
+    - .*_test\.go$
     - generate.go
   modules-download-mode: readonly
-linters-settings:
-  govet:
-    check-shadowing: true
-    enable-all: true
-    disable:
-      - asmdecl
-      - assign
-  errcheck:
-    check-type-assertions: true
-  misspell:
-    locale: UK
-    ignore-words:
-      - initialized
-  funlen:
-    lines: 80
-    statements: 40
-
-issues:
-  exclude-use-default: false
-  exclude:
-    - declaration of "(err|ctx)" shadows declaration at
-  exclude-rules:
-    - text: "^SA1019: .* is deprecated:"
-      linters:
-        - staticcheck
-    - path: _test\.go
-      linters:
-        - dupl
-        - gosec
-        - wsl
-        - lll
-        - funlen
-        - nlreturn
-        - unused
-    - path: _test\.go
-      text: ^Error return value is not checked$
-      linters:
-        - errcheck

Makefile

@@ -1,12 +1,9 @@
 ALL_GO_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; | sort)
-# extract go minor version from go version output
-GO_MINOR_VERSION := $(shell go version | cut -d' ' -f3 | cut -d'.' -f2)
 
 EXCLUDE_DIRS := ./examples
 EXCLUDE_GO_MOD_DIRS := $(shell find $(EXCLUDE_DIRS) -type f -name 'go.mod' -exec dirname {} \; | sort)
 
-# set build directory based on go minor version
-GO_BUILD_DIRS := $(foreach dir,$(ALL_GO_MOD_DIRS),$(shell GO_MOD_VERSION=$$(grep "go 1.[0-9]*" $(dir)/go.mod | cut -d' ' -f2 | cut -d'.' -f2) && [ -n "$$GO_MOD_VERSION" ] && [ $(GO_MINOR_VERSION) -ge $$GO_MOD_VERSION ] && echo $(dir)))
+GO_BUILD_DIRS := $(ALL_GO_MOD_DIRS)
 
 PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
 BIN_DIR := $(PROJECT_DIR)/.bin
@@ -21,10 +18,7 @@ vet:
 	@$(call run-go-mod-dir,go vet ./...,"go vet")
 
 lint: golangci-lint
-	@$(call run-go-mod-dir,$(GOLANGCI_LINT) run --timeout=10m -v,".bin/golangci-lint")
-
-.PHONY: ci
-ci: test test-cov test-xml
+	$(GOLANGCI_LINT) run --timeout=10m -v
 
 imports: gci
 	@$(call run-go-mod-dir,$(GCI) -w -local github.com/gojekfarm ./ | { grep -v -e 'skip file .*' || true; },".bin/gci")
@@ -40,9 +34,7 @@ generate: mockery protoc
 ## test: Run all tests
 .PHONY: test test-run test-cov test-xml
 
-test: check test-run
-
-test-run:
+test:
 	@$(call run-go-mod-dir,go test -race -covermode=atomic -coverprofile=coverage.out ./...,"go test")
 
 test-cov: gocov
@@ -64,19 +56,9 @@ check: fmt vet imports lint
 
 # ========= Helpers ===========
 
-## Determine the golangci-lint version based on $(GO_MINOR_VERSION)
-###################
-GOLANGCI_LINT_V18 := v1.50.1
-GOLANGCI_LINT_DEFAULT := v1.53.3
-
-get-golangci-lint-version = $(or $(value GOLANGCI_LINT_V$(1)), $(GOLANGCI_LINT_DEFAULT))
-GOLANGCI_LINT_VERSION := $(call get-golangci-lint-version,$(GO_MINOR_VERSION))
-
-###################
-
 GOLANGCI_LINT = $(BIN_DIR)/golangci-lint
 golangci-lint:
-	$(call go-get-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION))
+	$(call go-get-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest)
 
 GCI = $(BIN_DIR)/gci
 gci: