generated from lsytj0413/golang-project-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Makefile
170 lines (135 loc) · 6.2 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# The old school Makefile, following are required targets. The Makefile is written
# to allow building multiple binaries. You are free to add more targets or change
# existing implementations, as long as the semantics are preserved.
#
# make - default to 'build' target
# make lint - code analysis
# make test - run unit test (or plus integration test)
# make build - alias to build-local target
# make build-local - build local binary targets
# make build-linux - build linux binary targets
# make container - build containers
# $ docker login registry -u username -p xxxxx
# make push - push containers
# make clean - clean up targets
#
# Not included but recommended targets:
# make e2e-test
#
# The makefile is also responsible to populate project version information.
#
#
# Tweak the variables based on your project.
#
# This repo's root import path (under GOPATH).
ROOT := github.com/fornext-io/fornext
# Module name.
NAME := golang-project-template
# Container image prefix and suffix added to targets.
# The final built images are:
# $[REGISTRY]/$[IMAGE_PREFIX]$[TARGET]$[IMAGE_SUFFIX]:$[VERSION]
# $[REGISTRY] is an item from $[REGISTRIES], $[TARGET] is an item from $[TARGETS].
IMAGE_PREFIX ?= $(strip )
IMAGE_SUFFIX ?= $(strip )
# Container registries.
REGISTRY ?=
#
# These variables should not need tweaking.
#
# It's necessary to set this because some environments don't link sh -> bash.
export SHELL := /bin/bash
# It's necessary to set the errexit flags for the bash shell.
export SHELLOPTS := errexit
# Project main package location.
CMD_DIR := ./cmd
# Project output directory.
OUTPUT_DIR := ./bin
# Build directory.
BUILD_DIR := ./build
IMAGE_NAME := $(IMAGE_PREFIX)$(NAME)$(IMAGE_SUFFIX)
# Current version of the project.
VERSION ?= $(shell git describe --tags --always --dirty)
BRANCH ?= $(shell git branch | grep \* | cut -d ' ' -f2)
GITCOMMIT ?= $(shell git rev-parse HEAD)
GITTREESTATE ?= $(if $(shell git status --porcelain),dirty,clean)
BUILDDATE ?= $(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
appVersion ?= $(VERSION)
# Available cpus for compiling, please refer to https://major.io/2019/04/05/inspecting-openshift-cgroups-from-inside-the-pod/ for more information.
CPUS ?= $(shell /bin/bash hack/read_cpus_available.sh)
# Track code version with Docker Label.
DOCKER_LABELS ?= git-describe="$(shell date -u +v%Y%m%d)-$(shell git describe --tags --always --dirty)"
# Golang standard bin directory.
GOPATH ?= $(shell go env GOPATH)
BIN_DIR := $(GOPATH)/bin
GOLANGCI_LINT := $(BIN_DIR)/golangci-lint
# Default golang flags used in build and test
# -count: run each test and benchmark 1 times. Set this flag to disable test cache
export GOFLAGS ?= -count=1
#
# Define all targets. At least the following commands are required:
#
# All targets.
.PHONY: lint test build container push
build: build-local
# more info about `GOGC` env: https://github.com/golangci/golangci-lint#memory-usage-of-golangci-lint
lint: $(GOLANGCI_LINT)
@$(GOLANGCI_LINT) run
$(GOLANGCI_LINT):
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(BIN_DIR) v1.55.2
test:
# 1. Now we can use -race flag, the 'nosplit stack overflow' error will not happened at >= go1.20
# NOTE: see https://github.com/golang/go/issues/54291 for more detail
# 2. add -ldflags to prevent 'permission denied' in macos, see https://github.com/agiledragon/gomonkey/issues/70 for more detail.
@go test -v -race -ldflags="-extldflags="-Wl,-segprot,__TEXT,rwx,rx"" -coverpkg=./... -coverprofile=coverage.out -gcflags="all=-N -l" ./...
@go tool cover -func coverage.out | tail -n 1 | awk '{ print "Total coverage: " $$3 }'
build-local:
@go build -v -o $(OUTPUT_DIR)/$(NAME) \
-ldflags "-s -w -X $(ROOT)/pkg/utils/version.module=$(NAME) \
-X $(ROOT)/pkg/utils/version.version=$(VERSION) \
-X $(ROOT)/pkg/utils/version.branch=$(BRANCH) \
-X $(ROOT)/pkg/utils/version.gitCommit=$(GITCOMMIT) \
-X $(ROOT)/pkg/utils/version.gitTreeState=$(GITTREESTATE) \
-X $(ROOT)/pkg/utils/version.buildDate=$(BUILDDATE)" \
$(CMD_DIR);
build-linux:
/bin/bash -c 'GOOS=linux GOARCH=amd64 GOPATH=/go GOFLAGS="$(GOFLAGS)" \
go build -v -o $(OUTPUT_DIR)/$(NAME) \
-ldflags "-s -w -X $(ROOT)/pkg/utils/version.module=$(NAME) \
-X $(ROOT)/pkg/utils/version.version=$(VERSION) \
-X $(ROOT)/pkg/utils/version.branch=$(BRANCH) \
-X $(ROOT)/pkg/utils/version.gitCommit=$(GITCOMMIT) \
-X $(ROOT)/pkg/utils/version.gitTreeState=$(GITTREESTATE) \
-X $(ROOT)/pkg/utils/version.buildDate=$(BUILDDATE)" \
$(CMD_DIR)'
container:
@docker build -t $(REGISTRY)$(IMAGE_NAME):$(VERSION) \
--label $(DOCKER_LABELS) \
-f $(BUILD_DIR)/Dockerfile .;
push: container
@docker push $(REGISTRY)/$(IMAGE_NAME):$(VERSION);
.PHONY: clean
clean:
@-rm -vrf ${OUTPUT_DIR} output coverage.out
MOCKGEN := $(BIN_DIR)/mockgen
.PHONY: mock
mock: $(MOCKGEN)
mockgen -source=pkg/server/server.go -destination=pkg/server/mocks/server.go -package=mocks
$(MOCKGEN):
go install github.com/golang/mock/mockgen@v1.7.0-rc.1
addheaders:
@command -v addlicense > /dev/null || go install -v github.com/google/addlicense@v0.0.0-20210428195630-6d92264d7170
@addlicense -c "The fornext Authors" -l mit .
PROTOCGO := $(BIN_DIR)/protoc-gen-go
PROTOCGRPC := $(BIN_DIR)/protoc-gen-go-grpc
PROTOCGATEWAY := $(BIN_DIR)/protoc-gen-grpc-gateway
.PHONY: proto
proto: $(PROTOCGO) $(PROTOCGRPC) $(PROTOCGATEWAY)
@rm -rf ./pb
@./proto/generate.sh
$(PROTOCGO):
go install -v google.golang.org/protobuf/cmd/protoc-gen-go@v1.30.0
$(PROTOCGRPC):
go install -v google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
$(PROTOCGATEWAY):
go install -v github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@v2.15.2
go install -v github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@v2.15.2