From abde5fe50095bd7c6f56e40ef90671f0faded7aa Mon Sep 17 00:00:00 2001 From: Ian Cardoso Date: Fri, 5 May 2023 09:12:48 -0300 Subject: [PATCH] add format command on Makefile and remove vendor This commit adds the format command to make it easier to be compliant to golangci-lint issues Signed-off-by: Ian Cardoso --- CONTRIBUTING.md | 15 +++++++++++++++ Makefile | 7 ++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca74e665f759..092d31f0ad02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,3 +88,18 @@ Signed-off-by: Jane Smith In most cases, you can add this signoff to your commit automatically with the `-s` flag to `git commit`. Please use your real name and a reachable email address. + + +## Golangci-lint ## + +There is a CI check for formatting on our code, you'll need to install `goimports` to be able to attend this check, you can do it by running the command: + +``` +go install golang.org/x/tools/cmd/goimports@latest +``` + +then run: + +``` +make format +``` \ No newline at end of file diff --git a/Makefile b/Makefile index 9243cab14a53..aba74a95d273 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,6 @@ TARGETS := $(shell ls scripts | grep -v \\.sh) +GO_FILES ?= $$(find . -name '*.go' | grep -v generated) + .dapper: @echo Downloading dapper @@ -12,7 +14,6 @@ $(TARGETS): .dapper .PHONY: deps deps: - go mod vendor go mod tidy release: @@ -32,3 +33,7 @@ binary-size-check: .PHONY: image-scan image-scan: scripts/image_scan.sh $(IMAGE) + +format: + gofmt -s -l -w $(GO_FILES) + goimports -w $(GO_FILES) \ No newline at end of file