Skip to content

chore: add golangci-lint to CI #2784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xlgmokha wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: add golangci-lint to CI #2784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
version: "2"
run:
timeout: 5m
linters:
default: standard
enable:
- gosec
settings:
gosec:
excludes:
- G117
- G120
- G704
exclusions:
rules:
- linters: [gosec]
path: _test\.go
text: "(G101|G104)"
- linters: [errcheck, ineffassign]
path: _test\.go
- linters: [errcheck]
path: cmd/admin_cmd.go
- linters: [errcheck]
path: cmd/migrate_cmd.go
- linters: [errcheck]
path: cmd/serve_cmd.go
- linters: [errcheck]
path: internal/conf/confload/loader.go
- linters: [errcheck]
path: internal/e2e/e2eapi/e2eapi.go
- linters: [errcheck]
path: internal/e2e/e2ehooks/e2ehooks.go
- linters: [errcheck]
path: internal/hooks/hookshttp/hookshttp.go
- linters: [errcheck]
path: internal/indexworker/indexworker.go
- linters: [errcheck]
path: internal/mailer/templatemailer/template.go
- linters: [errcheck]
path: internal/mailer/validateclient/validateclient.go
- linters: [errcheck]
path: internal/reloader/poller.go
- linters: [errcheck]
path: internal/reloader/reloader.go
- linters: [errcheck]
path: internal/utilities/oidc_discovery.go
42 changes: 11 additions & 31 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: all build deps image migrate test vet sec vulncheck format hooks lint unused release
.PHONY: all build deps image migrate test sec vulncheck format hooks lint unused release golangci-lint
.PHONY: check-gosec check-govulncheck check-oapi-codegen check-staticcheck check-go-version check-format
CHECK_FILES ?= ./...

Expand Down Expand Up @@ -33,15 +33,14 @@ RELEASE_ARCHIVES = \

TOOL_BIN_DIR = tools/bin
TOOL_TARGETS = \
$(TOOL_BIN_DIR)/gosec \
$(TOOL_BIN_DIR)/staticcheck \
$(TOOL_BIN_DIR)/govulncheck
$(TOOL_BIN_DIR)/govulncheck \
$(TOOL_BIN_DIR)/golangci-lint


help: ## Show this help.
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)

all: check-go-version vet sec static build ## Run the tests and build the binary.
all: check-go-version golangci-lint build ## Run the tests and build the binary.

build: auth auth-amd64 auth-arm64 auth-darwin-arm64 ## Build the binaries.

Expand Down Expand Up @@ -74,9 +73,7 @@ deps: ## Install dependencies.

lint: \
check-go-version \
vet \
static \
sec \
golangci-lint \
vulncheck

release-test: lint test
Expand Down Expand Up @@ -117,41 +114,24 @@ test: auth ## Run tests.
go test -failfast $(CHECK_FILES) -coverprofile=coverage.out -coverpkg ./... -p 1 -race -v -count=1
./hack/coverage.sh

vet: # Vet the code
go vet $(CHECK_FILES)

check-go-version: ## Verify the pinned Go version matches across go.mod, Dockerfiles, and submodules.
./hack/check-go-version.sh

.NOTPARALLEL: $(TOOL_TARGETS)
$(TOOL_TARGETS):
$(MAKE) -C tools

sec: | $(TOOL_BIN_DIR)/gosec # Check for security vulnerabilities
$(TOOL_BIN_DIR)/gosec \
-quiet \
-exclude-generated \
-exclude=G117,G120,G704 \
$(CHECK_FILES)
$(TOOL_BIN_DIR)/gosec \
-quiet \
-tests \
-exclude-generated \
-exclude=G101,G104,G117,G120,G704 \
$(CHECK_FILES)
sec: | $(TOOL_BIN_DIR)/golangci-lint # Check for security issues (gosec)
$(TOOL_BIN_DIR)/golangci-lint run --enable-only=gosec $(CHECK_FILES)

vulncheck: $(TOOL_BIN_DIR)/govulncheck # Check for known vulnerabilities
$(TOOL_BIN_DIR)/govulncheck $(CHECK_FILES) | go run ./hack/vulncheck-filter

unused: | $(TOOL_BIN_DIR)/staticcheck # Look for unused code
@echo "Unused code:"
$(TOOL_BIN_DIR)/staticcheck -checks U1000 $(CHECK_FILES)
@echo
@echo "Code used only in _test.go (do move it in those files):"
$(TOOL_BIN_DIR)/staticcheck -checks U1000 -tests=false $(CHECK_FILES)
unused: | $(TOOL_BIN_DIR)/golangci-lint # Look for unused code
$(TOOL_BIN_DIR)/golangci-lint run --enable-only=unused $(CHECK_FILES)

static: | $(TOOL_BIN_DIR)/staticcheck
$(TOOL_BIN_DIR)/staticcheck ./...
golangci-lint: | $(TOOL_BIN_DIR)/golangci-lint
$(TOOL_BIN_DIR)/golangci-lint run $(CHECK_FILES)

generate: | check-oapi-codegen
go generate ./...
Expand Down
14 changes: 5 additions & 9 deletions tools/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
BIN_DIR := $(CURDIR)/bin
BIN_TARGETS := \
$(BIN_DIR)/gosec \
$(BIN_DIR)/staticcheck \
$(BIN_DIR)/govulncheck
$(BIN_DIR)/govulncheck \
$(BIN_DIR)/golangci-lint

.PHONY: all
all: $(BIN_TARGETS)

$(BIN_DIR)/gosec: | $(BIN_DIR)
GOBIN=$(BIN_DIR) go install github.com/securego/gosec/v2/cmd/gosec

$(BIN_DIR)/staticcheck: | $(BIN_DIR)
GOBIN=$(BIN_DIR) go install honnef.co/go/tools/cmd/staticcheck

$(BIN_DIR)/govulncheck: | $(BIN_DIR)
GOBIN=$(BIN_DIR) go install golang.org/x/vuln/cmd/govulncheck

$(BIN_DIR)/golangci-lint: | $(BIN_DIR)
GOBIN=$(BIN_DIR) go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint

$(BIN_DIR):
mkdir -p $(@)

Expand Down
Loading
Loading