Skip to content

Commit 3ae7a57

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #4752 from dongjiang1989/update-golangci-lint-v2
✨Update golangci-lint to v2.0.2 and adjust configuration
2 parents de4e5f0 + 8f628d8 commit 3ae7a57

File tree

73 files changed

+498
-391
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+498
-391
lines changed

‎.github/workflows/lint-sample.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ jobs:
3636
working-directory: ${{ matrix.folder }}
3737
run: make lint-config
3838
- name: Run linter
39-
uses: golangci/golangci-lint-action@v6
39+
uses: golangci/golangci-lint-action@v7
4040
with:
4141
install-mode: goinstall
42-
version: v1.63.4
42+
version: v2.0.2
4343
working-directory: ${{ matrix.folder }}
4444
args: --config .golangci.yml ./...
4545
- name: Run linter via makefile target

‎.github/workflows/lint.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ jobs:
2424
- name: Check linter configuration
2525
run: make lint-config
2626
- name: Run linter
27-
uses: golangci/golangci-lint-action@v6
27+
uses: golangci/golangci-lint-action@v7
2828
with:
2929
install-mode: goinstall
30-
version: v1.63.4
30+
version: v2.0.2
3131

3232
yamllint:
3333
runs-on: ubuntu-latest

‎.golangci.yml‎

Lines changed: 83 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,106 @@
1+
version: "2"
12
run:
2-
timeout: 5m
33
allow-parallel-runners: true
4-
5-
issues:
6-
# don't skip warning about doc comments
7-
# don't exclude the default set of lint
8-
exclude-use-default: false
9-
# restore some of the defaults
10-
# (fill in the rest as needed)
11-
exclude-rules:
12-
- linters: [gosec]
13-
path: "test/e2e/*"
14-
- path: "hack/docs/*"
15-
linters:
16-
- lll
17-
- gosec
18-
19-
linters-settings:
20-
ginkgolinter:
21-
forbid-focus-container: true
22-
forbid-spec-pollution: true
23-
govet:
24-
enable-all: true
25-
disable:
26-
- fieldalignment
27-
nolintlint:
28-
allow-unused: false
29-
revive:
30-
rules:
31-
# The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
32-
- name: blank-imports
33-
- name: context-as-argument
34-
- name: context-keys-type
35-
- name: dot-imports
36-
arguments:
37-
# dot import should be ONLY allowed for ginkgo testing packages
38-
- allowedPackages:
39-
- "github.com/onsi/ginkgo/v2"
40-
- "github.com/onsi/gomega"
41-
- name: error-return
42-
- name: error-strings
43-
- name: error-naming
44-
- name: exported
45-
- name: if-return
46-
- name: import-shadowing
47-
- name: increment-decrement
48-
- name: var-naming
49-
- name: var-declaration
50-
- name: package-comments
51-
disabled: true # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
52-
- name: range
53-
- name: receiver-naming
54-
- name: time-naming
55-
- name: unexported-return
56-
- name: indent-error-flow
57-
- name: errorf
58-
- name: empty-block
59-
- name: superfluous-else
60-
- name: unused-parameter
61-
- name: unreachable-code
62-
- name: redefines-builtin-id
63-
#
64-
# Rules in addition to the recommended configuration above.
65-
#
66-
- name: bool-literal-in-expr
67-
- name: constant-logical-expr
68-
- name: comment-spacings
694
linters:
70-
disable-all: true
5+
default: none
716
enable:
727
- asciicheck
738
- bidichk
9+
- copyloopvar
7410
- dupl
7511
- errcheck
76-
- copyloopvar
7712
- ginkgolinter
7813
- goconst
7914
- gocyclo
80-
- gofmt
81-
- gofumpt
82-
- goimports
83-
- gosimple
8415
- govet
8516
- ineffassign
8617
- lll
8718
- misspell
88-
- nolintlint
8919
- nakedret
20+
- nolintlint
9021
- prealloc
9122
- revive
9223
- staticcheck
93-
- typecheck
9424
- unconvert
9525
- unparam
9626
- unused
9727
- whitespace
98-
28+
settings:
29+
ginkgolinter:
30+
forbid-focus-container: true
31+
forbid-spec-pollution: true
32+
govet:
33+
disable:
34+
- fieldalignment
35+
enable-all: true
36+
nolintlint:
37+
allow-unused: false
38+
revive:
39+
rules:
40+
- name: blank-imports
41+
- name: context-as-argument
42+
- name: context-keys-type
43+
- name: dot-imports
44+
arguments:
45+
- allowedPackages:
46+
- github.com/onsi/ginkgo/v2
47+
- github.com/onsi/gomega
48+
- name: error-return
49+
- name: error-strings
50+
- name: error-naming
51+
- name: exported
52+
- name: if-return
53+
- name: import-shadowing
54+
- name: increment-decrement
55+
- name: var-naming
56+
- name: var-declaration
57+
- name: package-comments
58+
disabled: true
59+
- name: range
60+
- name: receiver-naming
61+
- name: time-naming
62+
- name: unexported-return
63+
- name: indent-error-flow
64+
- name: errorf
65+
- name: empty-block
66+
- name: superfluous-else
67+
- name: unused-parameter
68+
- name: unreachable-code
69+
- name: redefines-builtin-id
70+
- name: bool-literal-in-expr
71+
- name: constant-logical-expr
72+
- name: comment-spacings
73+
exclusions:
74+
generated: lax
75+
rules:
76+
- linters:
77+
- gosec
78+
path: test/e2e/*
79+
- linters:
80+
- gosec
81+
- lll
82+
path: hack/docs/*
83+
- linters:
84+
- staticcheck
85+
text: "ST1008:"
86+
- linters:
87+
- staticcheck
88+
text: "ST1001:"
89+
- linters:
90+
- revive
91+
text: 'should have comment or be unexported'
92+
paths:
93+
- third_party$
94+
- builtin$
95+
- examples$
96+
formatters:
97+
enable:
98+
- gofmt
99+
- gofumpt
100+
- goimports
101+
exclusions:
102+
generated: lax
103+
paths:
104+
- third_party$
105+
- builtin$
106+
- examples$

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ yamllint:
127127
GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
128128
golangci-lint:
129129
@[ -f $(GOLANGCI_LINT) ] || { \
130-
GOBIN=$(shell pwd)/bin go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.63.4 ;\
130+
GOBIN=$(shell pwd)/bin go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.0.2 ;\
131131
}
132132

133133
.PHONY: apidiff

‎docs/book/src/cronjob-tutorial/testdata/project/.github/workflows/lint.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ jobs:
1818
go-version-file: go.mod
1919

2020
- name: Run linter
21-
uses: golangci/golangci-lint-action@v6
21+
uses: golangci/golangci-lint-action@v7
2222
with:
23-
version: v1.63.4
23+
install-mode: goinstall
24+
version: v2.0.2

‎docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml‎

Lines changed: 40 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,15 @@
1+
version: "2"
12
run:
2-
timeout: 5m
33
allow-parallel-runners: true
4-
5-
issues:
6-
# don't skip warning about doc comments
7-
# don't exclude the default set of lint
8-
exclude-use-default: false
9-
# restore some of the defaults
10-
# (fill in the rest as needed)
11-
exclude-rules:
12-
- path: "api/*"
13-
linters:
14-
- lll
15-
- path: "internal/*"
16-
linters:
17-
- dupl
18-
- lll
194
linters:
20-
disable-all: true
5+
default: none
216
enable:
7+
- copyloopvar
228
- dupl
239
- errcheck
24-
- copyloopvar
2510
- ginkgolinter
2611
- goconst
2712
- gocyclo
28-
- gofmt
29-
- goimports
30-
- gosimple
3113
- govet
3214
- ineffassign
3315
- lll
@@ -36,13 +18,44 @@ linters:
3618
- prealloc
3719
- revive
3820
- staticcheck
39-
- typecheck
4021
- unconvert
4122
- unparam
4223
- unused
43-
44-
linters-settings:
45-
revive:
24+
settings:
25+
revive:
26+
rules:
27+
- name: comment-spacings
28+
- name: import-shadowing
29+
exclusions:
30+
generated: lax
4631
rules:
47-
- name: comment-spacings
48-
- name: import-shadowing
32+
- linters:
33+
- lll
34+
path: api/*
35+
- linters:
36+
- dupl
37+
- lll
38+
path: internal/*
39+
- linters:
40+
- staticcheck
41+
text: "ST1019"
42+
- linters:
43+
- staticcheck
44+
text: "ST1005"
45+
- linters:
46+
- staticcheck
47+
text: "QF1008"
48+
paths:
49+
- third_party$
50+
- builtin$
51+
- examples$
52+
formatters:
53+
enable:
54+
- gofmt
55+
- goimports
56+
exclusions:
57+
generated: lax
58+
paths:
59+
- third_party$
60+
- builtin$
61+
- examples$

‎docs/book/src/cronjob-tutorial/testdata/project/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ CONTROLLER_TOOLS_VERSION ?= v0.17.2
189189
ENVTEST_VERSION ?= $(shell go list -m -f "{{ .Version }}" sigs.k8s.io/controller-runtime | awk -F'[v.]' '{printf "release-%d.%d", $$2, $$3}')
190190
#ENVTEST_K8S_VERSION is the version of Kubernetes to use for setting up ENVTEST binaries (i.e. 1.31)
191191
ENVTEST_K8S_VERSION ?= $(shell go list -m -f "{{ .Version }}" k8s.io/api | awk -F'[v.]' '{printf "1.%d", $$3}')
192-
GOLANGCI_LINT_VERSION ?= v1.63.4
192+
GOLANGCI_LINT_VERSION ?= v2.0.2
193193

194194
.PHONY: kustomize
195195
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
@@ -217,7 +217,7 @@ $(ENVTEST): $(LOCALBIN)
217217
.PHONY: golangci-lint
218218
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
219219
$(GOLANGCI_LINT): $(LOCALBIN)
220-
$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
220+
$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
221221

222222
# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
223223
# $1 - target path with name of binary

‎docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ the "real" clock just calls `time.Now`.
5858
*/
5959
type realClock struct{}
6060

61-
func (_ realClock) Now() time.Time { return time.Now() }
61+
func (_ realClock) Now() time.Time { return time.Now() } //nolint:staticcheck
6262

6363
// Clock knows how to get the current time.
6464
// It can be used to fake out timing for testing.
@@ -388,7 +388,7 @@ func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
388388
starts++
389389
if starts > 100 {
390390
// We can't get the most recent times so just return an empty slice
391-
return time.Time{}, time.Time{}, fmt.Errorf("Too many missed start times (> 100). Set or decrease .spec.startingDeadlineSeconds or check clock skew.")
391+
return time.Time{}, time.Time{}, fmt.Errorf("Too many missed start times (> 100). Set or decrease .spec.startingDeadlineSeconds or check clock skew.") //nolint:staticcheck
392392
}
393393
}
394394
return lastMissed, sched.Next(now), nil

‎docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The `Default`method is expected to mutate the receiver, setting the defaults.
9898
*/
9999

100100
// Default implements webhook.CustomDefaulter so a webhook will be registered for the Kind CronJob.
101-
func (d *CronJobCustomDefaulter) Default(ctx context.Context, obj runtime.Object) error {
101+
func (d *CronJobCustomDefaulter) Default(_ context.Context, obj runtime.Object) error {
102102
cronjob, ok := obj.(*batchv1.CronJob)
103103

104104
if !ok {
@@ -169,7 +169,7 @@ type CronJobCustomValidator struct {
169169
var _ webhook.CustomValidator = &CronJobCustomValidator{}
170170

171171
// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type CronJob.
172-
func (v *CronJobCustomValidator) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
172+
func (v *CronJobCustomValidator) ValidateCreate(_ context.Context, obj runtime.Object) (admission.Warnings, error) {
173173
cronjob, ok := obj.(*batchv1.CronJob)
174174
if !ok {
175175
return nil, fmt.Errorf("expected a CronJob object but got %T", obj)
@@ -180,7 +180,7 @@ func (v *CronJobCustomValidator) ValidateCreate(ctx context.Context, obj runtime
180180
}
181181

182182
// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type CronJob.
183-
func (v *CronJobCustomValidator) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
183+
func (v *CronJobCustomValidator) ValidateUpdate(_ context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
184184
cronjob, ok := newObj.(*batchv1.CronJob)
185185
if !ok {
186186
return nil, fmt.Errorf("expected a CronJob object for the newObj but got %T", newObj)

‎docs/book/src/cronjob-tutorial/testdata/project/test/utils/utils.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
"os/exec"
2525
"strings"
2626

27-
. "github.com/onsi/ginkgo/v2" //nolint:golint,revive
27+
. "github.com/onsi/ginkgo/v2" //nolint:golint,revive,staticcheck
2828
)
2929

3030
const (
@@ -197,7 +197,7 @@ func GetProjectDir() (string, error) {
197197
if err != nil {
198198
return wd, fmt.Errorf("failed to get current working directory: %w", err)
199199
}
200-
wd = strings.Replace(wd, "/test/e2e", "", -1)
200+
wd = strings.ReplaceAll(wd, "/test/e2e", "")
201201
return wd, nil
202202
}
203203

0 commit comments

Comments
 (0)