-
Notifications
You must be signed in to change notification settings - Fork 6
/
Makefile
95 lines (75 loc) · 2.9 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
NAME := tfcw
FILES := $(shell git ls-files */*.go)
REPOSITORY := mvisonneau/$(NAME)
.DEFAULT_GOAL := help
.PHONY: setup
setup: ## Install required libraries/tools for build tasks
@command -v gofumpt 2>&1 >/dev/null || go install mvdan.cc/[email protected]
@command -v gosec 2>&1 >/dev/null || go install github.com/securego/gosec/v2/cmd/[email protected]
@command -v ineffassign 2>&1 >/dev/null || go install github.com/gordonklaus/[email protected]
@command -v misspell 2>&1 >/dev/null || go install github.com/client9/misspell/cmd/[email protected]
@command -v revive 2>&1 >/dev/null || go install github.com/mgechev/[email protected]
.PHONY: fmt
fmt: setup ## Format source code
gofumpt -w $(FILES)
.PHONY: lint
lint: revive vet gofumpt ineffassign misspell gosec ## Run all lint related tests against the codebase
.PHONY: revive
revive: setup ## Test code syntax with revive
revive -config .revive.toml $(FILES)
.PHONY: vet
vet: ## Test code syntax with go vet
go vet ./...
.PHONY: gofumpt
gofumpt: setup ## Test code syntax with gofumpt
gofumpt -d $(FILES) > gofumpt.out
@if [ -s gofumpt.out ]; then cat gofumpt.out; rm gofumpt.out; exit 1; else rm gofumpt.out; fi
.PHONY: ineffassign
ineffassign: setup ## Test code syntax for ineffassign
ineffassign ./...
.PHONY: misspell
misspell: setup ## Test code with misspell
misspell -error $(FILES)
.PHONY: gosec
gosec: setup ## Test code for security vulnerabilities
gosec -exclude=G307 ./...
.PHONY: test
test: ## Run the tests against the codebase
go test -v -count=1 -race ./...
.PHONY: install
install: ## Build and install locally the binary (dev purpose)
go install ./cmd/$(NAME)
.PHONY: build
build: ## Build the binaries using local GOOS
go build ./cmd/$(NAME)
.PHONY: release
release: ## Build & release the binaries (stable)
git tag -d edge
goreleaser release --rm-dist
find dist -type f -name "*.snap" -exec snapcraft upload --release stable,edge '{}' \;
.PHONY: prerelease
prerelease: setup ## Build & prerelease the binaries (edge)
@\
REPOSITORY=$(REPOSITORY) \
NAME=$(NAME) \
GITHUB_TOKEN=$(GITHUB_TOKEN) \
.github/prerelease.sh
.PHONY: clean
clean: ## Remove binary if it exists
rm -f $(NAME)
.PHONY: coverage
coverage: ## Generates coverage report
rm -rf *.out
go test -count=1 -race -v ./... -coverpkg=./... -coverprofile=coverage.out
.PHONY: coverage-html
coverage-html: ## Generates coverage report and displays it in the browser
go tool cover -html=coverage.out
.PHONY: is-git-dirty
is-git-dirty: ## Tests if git is in a dirty state
@git status --porcelain
@test $(shell git status --porcelain | grep -c .) -eq 0
.PHONY: all
all: lint test build coverage ## Test, builds and ship package for all supported platforms
.PHONY: help
help: ## Displays this help
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'