Skip to content

Commit 2db9105

Browse files
committed
Makefile cleanup and update
- update to golangci v2 - remove dependency on go-imports-reviser (in favor of golangci provided gci) - remove useless tasks - remove hack make-license Signed-off-by: apostasie <[email protected]>
1 parent f57f872 commit 2db9105

File tree

3 files changed

+80
-108
lines changed

3 files changed

+80
-108
lines changed

mod/tigron/.golangci.yml

+55-44
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,65 @@
1-
---
2-
output:
3-
sort-results: true
4-
5-
issues:
6-
max-issues-per-linter: 0
7-
max-same-issues: 0
1+
version: "2"
82

93
run:
10-
concurrency: 0
11-
timeout: 5m
124
issues-exit-code: 2
13-
tests: true
145
modules-download-mode: readonly
156
allow-parallel-runners: true
167
allow-serial-runners: true
178

9+
issues:
10+
max-issues-per-linter: 0
11+
max-same-issues: 0
12+
1813
linters:
19-
disable-all: false
20-
enable-all: true
14+
default: all
2115
disable:
22-
# Opting-out
23-
- nonamedreturns # named returns are occasionally useful
24-
- exhaustruct # does not serve much of a purpose
25-
- funlen # not interested
26-
- cyclop # not interested much
27-
- godox # having these are useful
28-
# Duplicating
29-
- gci # we use go-imports instead
30-
# Deprecated
31-
- tenv
32-
# TODO: Temporarily out until we wrap up all of them
33-
# - wrapcheck
34-
35-
linters-settings:
36-
staticcheck:
37-
checks:
38-
- "all"
16+
- cyclop
17+
- exhaustruct
18+
- funlen
19+
- godox
20+
- nonamedreturns
21+
settings:
22+
depguard:
23+
rules:
24+
main:
25+
files:
26+
- $all
27+
allow:
28+
- $gostd
29+
- github.com/containerd/nerdctl/mod/tigron
30+
- github.com/creack/pty
31+
- github.com/rs/zerolog
32+
- github.com/rs/zerolog/log
33+
- go.uber.org/goleak
34+
- golang.org/x/sync/errgroup
35+
- golang.org/x/term
36+
- gotest.tools
37+
staticcheck:
38+
checks:
39+
- all
40+
exclusions:
41+
generated: disable
3942

40-
depguard:
41-
rules:
42-
main:
43-
files:
44-
- "$all"
45-
allow:
46-
- $gostd
47-
- "github.com/containerd/nerdctl/mod/tigron"
48-
# WATCHOUT! https://github.com/OpenPeeDeeP/depguard/issues/108
49-
# Currently, depguard will fail detecting any dependency starting with a standard package name as third-party.
50-
# Thus, the following three are allowed provisionally, though currently not "necessary".
51-
- "golang.org/x/sync"
52-
- "golang.org/x/term"
53-
- "gotest.tools"
54-
- "github.com/creack/pty"
43+
formatters:
44+
settings:
45+
gci:
46+
sections:
47+
- standard
48+
- default
49+
- prefix(github.com/containerd)
50+
- localmodule
51+
no-inline-comments: true
52+
no-prefix-comments: true
53+
custom-order: true
54+
gofumpt:
55+
extra-rules: true
56+
golines:
57+
max-len: 100
58+
tab-len: 4
59+
shorten-comments: true
60+
enable:
61+
- gci
62+
- gofumpt
63+
- golines
64+
exclusions:
65+
generated: disable

mod/tigron/Makefile

+25-34
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ endef
5757
##########################
5858
# High-level tasks definitions
5959
##########################
60-
lint: lint-go-all lint-imports lint-yaml lint-shell lint-commits lint-headers lint-mod lint-licenses-all
60+
lint: lint-go-all lint-yaml lint-shell lint-commits lint-headers lint-mod lint-licenses-all
6161
test: test-unit test-unit-race test-unit-bench
6262
unit: test-unit test-unit-race test-unit-bench
63-
fix: fix-mod fix-imports fix-go-all
63+
fix: fix-mod fix-go-all
6464

6565
##########################
6666
# Linting tasks
6767
##########################
6868
lint-go:
69-
$(call title, $@)
69+
$(call title, $@: $(GOOS))
7070
@cd $(MAKEFILE_DIR) \
7171
&& golangci-lint run $(VERBOSE_FLAG_LONG) ./...
7272
$(call footer, $@)
@@ -80,12 +80,6 @@ lint-go-all:
8080
&& GOOS=windows make lint-go
8181
$(call footer, $@)
8282

83-
lint-imports:
84-
$(call title, $@)
85-
@cd $(MAKEFILE_DIR) \
86-
&& goimports-reviser -recursive -list-diff -set-exit-status -output stdout -company-prefixes "$(ORG_PREFIXES)" ./...
87-
$(call footer, $@)
88-
8983
lint-yaml:
9084
$(call title, $@)
9185
@cd $(MAKEFILE_DIR) \
@@ -115,10 +109,15 @@ lint-mod:
115109
&& go mod tidy --diff
116110
$(call footer, $@)
117111

112+
# FIXME: go-licenses cannot find LICENSE from root of repo when submodule is imported:
113+
# https://github.com/google/go-licenses/issues/186
114+
# This is impacting gotest.tools
118115
lint-licenses:
119-
$(call title, $@)
116+
$(call title, $@: $(GOOS))
120117
@cd $(MAKEFILE_DIR) \
121-
&& ./hack/make-lint-licenses.sh
118+
&& go-licenses check --include_tests --allowed_licenses=Apache-2.0,BSD-2-Clause,BSD-3-Clause,MIT,MPL-2.0 \
119+
--ignore gotest.tools \
120+
./...
122121
$(call footer, $@)
123122

124123
lint-licenses-all:
@@ -134,7 +133,7 @@ lint-licenses-all:
134133
# Automated fixing tasks
135134
##########################
136135
fix-go:
137-
$(call title, $@)
136+
$(call title, $@: $(GOOS))
138137
@cd $(MAKEFILE_DIR) \
139138
&& golangci-lint run --fix
140139
$(call footer, $@)
@@ -148,12 +147,6 @@ fix-go-all:
148147
&& GOOS=windows make fix-go
149148
$(call footer, $@)
150149

151-
fix-imports:
152-
$(call title, $@)
153-
@cd $(MAKEFILE_DIR) \
154-
&& goimports-reviser -company-prefixes $(ORG_PREFIXES) ./...
155-
$(call footer, $@)
156-
157150
fix-mod:
158151
$(call title, $@)
159152
@cd $(MAKEFILE_DIR) \
@@ -171,26 +164,24 @@ up:
171164
##########################
172165
install-dev-tools:
173166
$(call title, $@)
174-
# golangci: v1.64.5
175-
# git-validation: main from 2023/11
176-
# ltag: v0.2.5
177-
# go-licenses: v2.0.0-alpha.1
178-
# goimports-reviser: v3.9.0
167+
# golangci: v2.0.2 (2024-03-26)
168+
# git-validation: main (2025-02-25)
169+
# ltag: main (2025-03-04)
170+
# go-licenses: v2.0.0-alpha.1 (2024-06-27)
179171
@cd $(MAKEFILE_DIR) \
180-
&& go install github.com/golangci/golangci-lint/cmd/golangci-lint@0a603e49e5e9870f5f9f2035bcbe42cd9620a9d5 \
181-
&& go install github.com/vbatts/git-validation@679e5cad8c50f1605ab3d8a0a947aaf72fb24c07 \
182-
&& go install github.com/kunalkushwaha/ltag@b0cfa33e4cc9383095dc584d3990b62c95096de0 \
183-
&& go install github.com/google/go-licenses/v2@d01822334fba5896920a060f762ea7ecdbd086e8 \
184-
&& go install github.com/incu6us/goimports-reviser/v3@698f92d226d50a01731ca8551993ebc1bb7fc788
185-
@echo "Remember to add GOROOT/bin to your path"
172+
&& go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@2b224c2cf4c9f261c22a16af7f8ca6408467f338 \
173+
&& go install github.com/vbatts/git-validation@7b60e35b055dd2eab5844202ffffad51d9c93922 \
174+
&& go install github.com/containerd/ltag@66e6a514664ee2d11a470735519fa22b1a9eaabd \
175+
&& go install github.com/google/go-licenses/v2@d01822334fba5896920a060f762ea7ecdbd086e8
176+
@echo "Remember to add \$$HOME/go/bin to your path"
186177
$(call footer, $@)
187178

188179
##########################
189180
# Testing tasks
190181
##########################
191182
test-unit:
192183
$(call title, $@)
193-
@go test $(VERBOSE_FLAG) $(MAKEFILE_DIR)/...
184+
@EXPERIMENTAL_HIGHK_FD=true go test $(VERBOSE_FLAG) $(MAKEFILE_DIR)/...
194185
$(call footer, $@)
195186

196187
test-unit-bench:
@@ -200,7 +191,7 @@ test-unit-bench:
200191

201192
test-unit-race:
202193
$(call title, $@)
203-
@go test $(VERBOSE_FLAG) $(MAKEFILE_DIR)/... -race
194+
@EXPERIMENTAL_HIGHK_FD=true go test $(VERBOSE_FLAG) $(MAKEFILE_DIR)/... -race
204195
$(call footer, $@)
205196

206197
.PHONY: \
@@ -210,6 +201,6 @@ test-unit-race:
210201
up \
211202
unit \
212203
install-dev-tools \
213-
lint-commits lint-go lint-go-all lint-headers lint-imports lint-licenses lint-licenses-all lint-mod lint-shell lint-yaml \
214-
fix-go fix-go-all fix-imports fix-mod \
215-
test-unit test-unit-race test-unit-bench
204+
lint-commits lint-go lint-go-all lint-headers lint-licenses lint-licenses-all lint-mod lint-shell lint-yaml \
205+
fix-go fix-go-all fix-mod \
206+
test-unit test-unit-race test-unit-bench

mod/tigron/hack/make-lint-licenses.sh

-30
This file was deleted.

0 commit comments

Comments
 (0)