Merge pull request #8223 from onflow/peter/fix-ci-lint

[CI] update golanglint-ci

Author: peterargue

.custom-gcl.yml

@@ -1,5 +1,5 @@
 # The version of golangci-lint used to build the custom binary
-version: v1.63.4
+version: v2.7.1
 
 # The name of the custom binary
 name: custom-gcl

.github/workflows/ci.yml

@@ -55,18 +55,12 @@ jobs:
           path: tools/custom-gcl # path defined in .custom-gcl.yml
           lookup-only: 'true'    # if already cached, don't download here
       # We install the non-custom golangci-lint binary using the golangci-lint action.
-      # The action is set up to always install and run the linter - there isn't a way to only install.
-      # We provide args to disable all linters which results in the step immediately failing.
       - name: Install golangci-lint
         if: steps.cache-linter.outputs.cache-hit != 'true'
-        uses: golangci/golangci-lint-action@v6
-        continue-on-error: true # after installation (what we care about), this step will fail - this line allows workflow to continue
+        uses: golangci/golangci-lint-action@v9
         with:
-          args: "--no-config --disable-all" # set args so that no linters are actually run
-      - name: Build custom linter binary
-        if: steps.cache-linter.outputs.cache-hit != 'true'
-        run: |
-          golangci-lint custom
+          install-only: true
+          version: v2.7.1
 
   golangci:
     strategy:
@@ -112,7 +106,7 @@ jobs:
     - name: Add custom linter binary to path
       run: echo "$(pwd)/tools" >> $GITHUB_PATH
     - name: Run golangci-lint
-      uses: golangci/golangci-lint-action@v6
+      uses: golangci/golangci-lint-action@v9
       with:
         install-mode: 'none' # looks for binary in path rather than downloading
         args: "-v"

.golangci.yml

@@ -1,77 +1,90 @@
-run:
-  timeout: 10m
-
-linters-settings:
-  goimports:
-    # enforced by linter
-    # put imports beginning with prefix after 3rd-party packages;
-    # it's a comma-separated list of prefixes
-    local-prefixes: github.com/onflow/flow-go/
-
-  # used to generate canonical import ordering
-  # not enforced by linter
-  gci:
-    sections:
-      - standard                           # 1. standard library
-      - default                            # 2. external packages
-      - prefix(github.com/onflow/)         # 3. org packages
-      - prefix(github.com/onflow/flow-go/) # 4. project packages
-    skip-generated: true
-    custom-order: true
-
-  gosec:
-    # To select a subset of rules to run.
-    # Available rules: https://github.com/securego/gosec#available-rules
-    includes:
-      - G401
-      - G402
-      - G501
-      - G502
-      - G503
-      - G505
-
-  staticcheck:
-    # Disable SA1019 to allow use of deprecated label
-    checks: ["all", "-SA1019"]
-
-  custom:
-    structwrite:
-      type: module
-      description: "disallow struct field writes outside constructor"
-      original-url: "github.com/onflow/flow-go/tools/structwrite"
-
+version: "2"
 linters:
   enable:
-    - goimports
     - gosec
     - structwrite
+  settings:
+    gosec:
+      includes:
+        - G401
+        - G402
+        - G501
+        - G502
+        - G503
+        - G505
+    staticcheck:
+      checks:
+        - all
+        - -SA1019
 
-issues:
-  exclude-rules:
-    - path: _test\.go # disable some linters on test files
-      linters:
-        - unused
-        - structwrite
-    - path: 'consensus/hotstuff/helper/*' # disable some linters on test helper files
-      linters:
-        - structwrite
-    - path: 'utils/unittest/*' # disable some linters on test files
-      linters:
-        - structwrite
-    - path: 'consensus/hotstuff/helper/*' # disable some linters on test files
-      linters:
-        - structwrite
-    - path: 'engine/execution/testutil/*' # disable some linters on test files
-      linters:
-        - structwrite
-    # typecheck currently not handling the way we do function inheritance well
-    # disabling for now
-    - path: 'cmd/access/node_build/*'
-      linters:
-        - typecheck
-    - path: 'cmd/observer/node_builder/*'
-      linters:
-        - typecheck
-    - path: 'follower/*'
-      linters:
-        - typecheck
+        # TODO: these were added to allow updating to the latest version of the linter.
+        # Update the code to remove these issues instead of suppressing them.
+        - -QF1001 # could apply De Morgan's law" were hidden
+        - -QF1003 # could use tagged switch on chainID (staticcheck)
+        - -QF1006 # could lift into loop condition (staticcheck)
+        - -QF1008 # could remove embedded field \"BaseConfig\" from selector" were hidden
+        - -QF1011 # could omit type flow.IdentifierList from declaration; it will be inferred from the right-hand side" were hidden
+        - -QF1012 # Use fmt.Fprintf(...) instead of Write([]byte(fmt.Sprintf(...))) (staticcheck)
+        - -S1021 # should merge variable declaration with assignment on next line (staticcheck)
+        - -ST1003 # should not use underscores in package names" were hidden
+        - -ST1005 # error strings should not be capitalized" were hidden
+        - -ST1006 # receiver name should not be an underscore, omit the name if it is unused (staticcheck)
+        - -ST1008 # error should be returned as the last argument" were hidden
+        - -ST1012 # error var factoryError should have name of the form errFoo" were hidden
+        - -ST1016 # methods on the same type should have the same receiver name (seen 45x "db", 4x "s") (staticcheck)
+        - -ST1017 # don't use Yoda conditions" were hidden
+        - -ST1019 # other import of \"github.com/onflow/flow-go/model/bootstrap\"" were hidden
+        - -ST1023 # should omit type flow.IdentifierList from declaration; it will be inferred from the right-hand side" were hidden
+    custom:
+      structwrite:
+        type: module
+        description: disallow struct field writes outside constructor
+        original-url: github.com/onflow/flow-go/tools/structwrite
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - structwrite
+          - unused
+        path: _test\.go
+      - linters:
+          - structwrite
+        path: consensus/hotstuff/helper/*
+      - linters:
+          - structwrite
+        path: utils/unittest/*
+      - linters:
+          - structwrite
+        path: consensus/hotstuff/helper/*
+      - linters:
+          - structwrite
+        path: engine/execution/testutil/*
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - goimports
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - prefix(github.com/onflow/)
+        - prefix(github.com/onflow/flow-go/)
+      custom-order: true
+    goimports:
+      local-prefixes:
+        - github.com/onflow/flow-go/
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

state/protocol/datastore/validity.go

@@ -176,7 +176,7 @@ func validateClusterQC(cluster protocol.Cluster) error {
 // version beacon is invalid
 func validateVersionBeacon(snap protocol.Snapshot) error {
 	errf := func(msg string, args ...any) error {
-		return protocol.NewInvalidServiceEventErrorf(msg, args)
+		return protocol.NewInvalidServiceEventErrorf(msg, args...)
 	}
 
 	versionBeacon, err := snap.VersionBeacon()