clean up ci, use go 1.24, apply best practices for ci and general clean up

.github/workflows/ci.yml

@@ -10,10 +10,15 @@ on:
       - .gitignore
   merge_group:
 
+permissions: {}
+
 jobs:
   lint:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+
     env:
       GOPATH: /home/runner/go
 
@@ -22,20 +27,21 @@ jobs:
       uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       with:
         submodules: recursive
+        persist-credentials: false
 
     - name: Setup Go
       uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
       with:
-        go-version: '1.21'
+        go-version-file: './.go-version'
         check-latest: true
 
     - name: Format check
       run: make fmt
 
     - name: golangci-lint
-      uses: golangci/golangci-lint-action@aaa42aa0628b4ae2578232a66b541047968fac86 # v6.1.0
+      uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # v8.0.0
       with:
-        version: v1.59
+        version: v2.2
         args: --build-tags testonly
 
     - name: Check generated code

.github/workflows/codeql.yml

@@ -8,6 +8,9 @@ on:
   schedule:
     - cron: '21 6 * * 6'
 
+
+permissions: {}
+
 jobs:
   analyze:
     name: Analyze (${{ matrix.language }})

.github/workflows/coverage.yml

@@ -13,15 +13,22 @@ on:
       - main
   merge_group:
 
+
+permissions: {}
+
 jobs:
   coverage:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+
     strategy:
+      fail-fast: false
       matrix:
         go-version:
-          - '1.21'
-          - '1.22'
+          - '1.23'
+          - '1.24'
 
     env:
       GOPATH: /home/runner/go
@@ -31,6 +38,7 @@ jobs:
       uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       with:
         submodules: recursive
+        persist-credentials: false
 
     - name: Setup Go
       uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2

.github/workflows/dco_merge_group.yaml

@@ -2,9 +2,11 @@ name: DCO
 on:
   merge_group:
 
+permissions: {}
+
 jobs:
   DCO:
     runs-on: ubuntu-latest
     if: ${{ github.actor != 'dependabot[bot]' }}
     steps:
-      - run: echo "dummy DCO workflow (it won't run any check actually) to trigger by merge_group in order to enable merge queue"
+      - run: echo "dummy DCO workflow (it won't run any check actually) to trigger by merge_group in order to enable merge queue"

.go-version

@@ -0,0 +1 @@
+1.24.4

.golangci.yml

@@ -0,0 +1,49 @@
+version: "2"
+run:
+  issues-exit-code: 1
+linters:
+  enable:
+    - asciicheck
+    - errorlint
+    - gocritic
+    - gosec
+    - importas
+    - misspell
+    - prealloc
+    # - revive # disabled due becasue ask to change some variables and functions that might break the api compatibility
+    - staticcheck
+    - tparallel
+    - unconvert
+    - unparam
+    - whitespace
+
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - errcheck
+          - gosec
+        path: _test\.go
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  uniq-by-line: false
+formatters:
+  enable:
+    - gofmt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.goreleaser.yaml

@@ -1,24 +1,23 @@
+version: 2
+
 before:
   hooks:
     - go mod tidy
+
 builds:
   - env:
       - CGO_ENABLED=0
     goos:
       - linux
       - windows
       - darwin
-archives:
-  - replacements:
-      darwin: Darwin
-      linux: Linux
-      windows: Windows
-      386: i386
-      amd64: x86_64
+
 checksum:
   name_template: 'checksums.txt'
+
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
+
 changelog:
   sort: asc
   filters:

DEVELOPMENT.md

@@ -17,7 +17,7 @@ You must install these tools:
 1. [`git`](https://help.github.com/articles/set-up-git/): For source control
 
 1. [`go`](https://golang.org/doc/install): The language this SDK is built in.
-    > **Note** Golang [version v1.18](https://golang.org/dl/) or higher is required.
+    > **Note** Golang [version v1.23](https://golang.org/dl/) or higher is required.
 
 1. [`make`](https://www.gnu.org/software/make/): not stricly required but handy to run
    tests with a single command.
@@ -85,4 +85,3 @@ To run all targets, before creating a commit:
 ```shell
 make all
 ```
-

pkg/api/bindings.go

@@ -108,7 +108,7 @@
 	// Validate the event
 	err := Validate(event)
 	if err != nil {
-		return nil, fmt.Errorf("cannot validate CDEvent %v", err)
+		return nil, fmt.Errorf("cannot validate CDEvent %w", err)
 	}
 	ce := cloudevents.NewEvent()
 	ce.SetID(event.GetId())
@@ -149,10 +149,10 @@
 	var v interface{}
 	jsonString, err := AsJsonString(event)
 	if err != nil {
-		return fmt.Errorf("cannot render the event %s as json %s", event, err)
+		return fmt.Errorf("cannot render the event %s as json %w", event, err)
 	}
 	if err := json.Unmarshal([]byte(jsonString), &v); err != nil {
-		return fmt.Errorf("cannot unmarshal event json: %v", err)
+		return fmt.Errorf("cannot unmarshal event json: %w", err)
 	}
 	// Validate the "validate" tags
 	if err := validate.Struct(event); err != nil {

pkg/api/bindings_test.go

@@ -143,7 +143,7 @@ func setContext(event api.CDEventWriter, subjectId string) {
 	event.SetSubjectId(subjectId)
 }
 
-func setContextV04(event api.CDEventWriterV04, chainId, schemaUri bool) {
+func setContextV04(event api.CDEventWriterV04, chainId, schemaUri bool) { //nolint: unparam
 	if chainId {
 		event.SetChainId(testChainId)
 	}
@@ -239,7 +239,6 @@ func init() {
 // TestAsCloudEvent produces a CloudEvent from a CDEvent using `AsCloudEvent`
 // and then attempts to parse the CloudEvent payload back into a specific CDEvent
 func TestAsCloudEvent(t *testing.T) {
-
 	tests := []struct {
 		name  string
 		event api.CDEventReader
@@ -309,7 +308,6 @@ func TestAsCloudEvent(t *testing.T) {
 }
 
 func TestAsCloudEventInvalid(t *testing.T) {
-
 	tests := []struct {
 		name  string
 		event api.CDEventReader
@@ -353,7 +351,6 @@ func TestAsCloudEventInvalid(t *testing.T) {
 // rendered JSON depends on a number of factors, and is not deterministic
 // so we must compare events unmarshalled to an interface
 func TestAsJsonBytes(t *testing.T) {
-
 	tests := []struct {
 		name     string
 		event    api.CDEvent
@@ -393,7 +390,7 @@ func TestAsJsonBytes(t *testing.T) {
 			if err != nil {
 				t.Fatalf("didn't expected it to fail, but it did: %v", err)
 			}
-			err = json.Unmarshal([]byte(obtainedJsonString), &obtainedInteface)
+			err = json.Unmarshal(obtainedJsonString, &obtainedInteface)
 			if err != nil {
 				t.Fatalf("didn't expected it to fail, but it did: %v", err)
 			}
@@ -409,7 +406,6 @@ func TestAsJsonBytes(t *testing.T) {
 }
 
 func TestInvalidEvent(t *testing.T) {
-
 	// mandatory source missing
 	eventNoSource, _ := testapi.NewFooSubjectBarPredicateEvent()
 	eventNoSource.SetSubjectId(testSubjectId)
@@ -506,7 +502,6 @@ func TestAsJsonStringEmpty(t *testing.T) {
 }
 
 func TestNewFromJsonString(t *testing.T) {
-
 	tests := []struct {
 		name     string
 		event    api.CDEventV04
@@ -582,7 +577,6 @@ func TestNewFromJsonString(t *testing.T) {
 }
 
 func TestParseType(t *testing.T) {
-
 	tests := []struct {
 		name      string
 		eventType string
@@ -668,7 +662,6 @@ func testEventWithVersion(eventVersion string, specVersion string) *testapi.FooS
 }
 
 func TestNewFromJsonBytes(t *testing.T) {
-
 	minorVersion := testEventWithVersion("2.999.1", testapi.SpecVersion)
 	patchVersion := testEventWithVersion("2.2.999", testapi.SpecVersion)
 	pastPatchVersion := testEventWithVersion("2.2.0", testapi.SpecVersion)

pkg/api/factory.go

@@ -28,7 +28,7 @@ import (
 var timeNow = time.Now
 var uuidNewRandom = uuid.NewRandom
 
-func initCDEvent(e CDEvent) (CDEvent, error) {
+func initCDEvent(e CDEvent) (CDEvent, error) { //nolint: unparam
 	eventUUID, err := uuidNewRandom()
 	if err != nil {
 		return nil, err

pkg/api/types.go

@@ -290,28 +290,29 @@
 		if err != nil {
 			return err
 		}
-		if m.LinkType == LinkTypeEnd {
+		switch m.LinkType {
+		case LinkTypeEnd:
 			var e embeddedLinkEnd
 			err = json.Unmarshal(*rawEmbeddedLink, &e)
 			if err != nil {
 				return err
 			}
 			receiver[index] = &e
-		} else if m.LinkType == LinkTypePath {
+		case LinkTypePath:
 			var e embeddedLinkPath
 			err = json.Unmarshal(*rawEmbeddedLink, &e)
 			if err != nil {
 				return err
 			}
 			receiver[index] = &e
-		} else if m.LinkType == LinkTypeRelation {
+		case LinkTypeRelation:
 			var e embeddedLinkRelation
 			err = json.Unmarshal(*rawEmbeddedLink, &e)
 			if err != nil {
 				return err
 			}
 			receiver[index] = &e
-		} else {
+		default:
 			return fmt.Errorf("unsupported link type %s found", m.LinkType)
 		}
 	}

pkg/api/types_test.go

@@ -76,7 +76,6 @@ type testWrongType struct {
 }
 
 func TestGetCustomDataAsNonJson(t *testing.T) {
-
 	receiver := &testType{}
 	expectedError := "cannot unmarshal content-type application/xml"
 
@@ -91,7 +90,6 @@ func TestGetCustomDataAsNonJson(t *testing.T) {
 }
 
 func TestGetCustomDataAsJson(t *testing.T) {
-
 	receiver := &testType{}
 	expectedValue := "testValue"
 
@@ -127,7 +125,6 @@ func TestGetCustomDataAsJson(t *testing.T) {
 }
 
 func TestGetCustomDataAsJsonInvalidReceiver(t *testing.T) {
-
 	receiver := &testWrongType{}
 	expectedReceiver := &testWrongType{}
 
@@ -163,7 +160,6 @@ func TestGetCustomDataAsJsonInvalidReceiver(t *testing.T) {
 }
 
 func TestSetCustomData(t *testing.T) {
-
 	tests := []struct {
 		name         string
 		contentType  string
@@ -215,7 +211,6 @@ func TestSetCustomDataInvalid(t *testing.T) {
 }
 
 func TestGetCustomData(t *testing.T) {
-
 	tests := []struct {
 		name         string
 		contentType  string
@@ -302,7 +297,6 @@ func TestGetCustomDataXmlNotBytes(t *testing.T) {
 }
 
 func TestGetCustomDataRaw(t *testing.T) {
-
 	tests := []struct {
 		name         string
 		contentType  string
@@ -327,7 +321,7 @@ func TestGetCustomDataRaw(t *testing.T) {
 		name:         "json, interface",
 		contentType:  "application/json",
 		data:         testType{TestData: "testValue"},
-		expectedData: []byte(testJsonString),
+		expectedData: testJsonString,
 	}}
 
 	for _, tc := range tests {