-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
104 lines (82 loc) · 2.83 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
96
97
98
99
100
101
102
103
104
# Change these variables as necessary.
MAIN_PACKAGE_PATH := ./cmd/crawler/
TMP_DIR := ./tmp
BINARY_NAME := apk-crawler
# ==================================================================================== #
# HELPERS
# ==================================================================================== #
.PHONY: prepare
prepare:
mkdir -p ${TMP_DIR}/bin
go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]
go install github.com/vektra/mockery/[email protected]
go env -w CGO_ENABLED=1
## help: print this help message
.PHONY: help
help:
@echo 'Usage:'
@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'
.PHONY: confirm
confirm:
@echo -n 'Are you sure? [y/N] ' && read ans && [ $${ans:-N} = y ]
.PHONY: no-dirty
no-dirty:
git diff --exit-code
# ==================================================================================== #
# QUALITY CONTROL
# ==================================================================================== #
## tidy: format code and tidy modfile
.PHONY: tidy
tidy:
go fmt ./...
go mod tidy -v
## audit: run quality control checks
.PHONY: audit
audit:
go mod verify
go vet ./...
go run github.com/golangci/golangci-lint/cmd/[email protected] run ./...
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
# ==================================================================================== #
# DEVELOPMENT
# ==================================================================================== #
.PHONY: proto
proto:
@protoc --go_out=. --go_opt=paths=source_relative ./proto/*.proto
.PHONY: mocks
mocks:
@mockery --all
## test: run all tests
.PHONY: test
test:
go test -v -race -buildvcs ./...
## test/cover: run all tests and display coverage
.PHONY: test/cover
test/cover:
go test -v -race -buildvcs -coverprofile=${TMP_DIR}/coverage.out.tmp ./...
cat ${TMP_DIR}/coverage.out.tmp | grep -Ev "mock_|mocks/|cmd/|.pb.go" > ${TMP_DIR}/coverage.out
go tool cover -html=${TMP_DIR}/coverage.out
## build: build the application
.PHONY: build
build:
go build -o=${TMP_DIR}/bin/${BINARY_NAME} ${MAIN_PACKAGE_PATH}
## run: run the application
.PHONY: run
run: build
${TMP_DIR}/bin/${BINARY_NAME}
## run/live: run the application with reloading on file changes
.PHONY: run/live
run/live:
go run github.com/cosmtrek/[email protected]
# ==================================================================================== #
# OPERATIONS
# ==================================================================================== #
## push: push changes to the remote Git repository
.PHONY: push
push: tidy audit no-dirty
git push
## production/deploy: deploy the application to production
.PHONY: production/build
production/build:
GOOS=linux GOARCH=amd64 go build -ldflags='-s -w' -o=${TMP_DIR}/bin/linux_amd64/${BINARY_NAME} ${MAIN_PACKAGE_PATH}