-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Makefile
138 lines (101 loc) · 3.88 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
# Copyright 2020 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# If you update this file, please follow
# https://suva.sh/posts/well-documented-makefiles
REPO_ROOT := $(shell git rev-parse --show-toplevel)
.DEFAULT_GOAL:=help
SHELL:=/usr/bin/env bash
COLOR:=\\033[36m
NOCOLOR:=\\033[0m
##@ KEPs
.PHONY: update-toc verify-toc verify-metadata
update-toc: ## Updates KEP Table of Contents.
${REPO_ROOT}/hack/update-toc.sh
verify-toc: ## Verifies the Table of Contents is in the correct format.
${REPO_ROOT}/hack/verify-toc.sh
verify-metadata: ## Verifies the KEP metadata is valid yaml.
${REPO_ROOT}/hack/verify-kep-metadata.sh
##@ Verify
.PHONY: add-verify-hook verify verify-boilerplate verify-build verify-golangci-lint verify-go-mod verify-shellcheck verify-spelling
add-verify-hook: ## Adds verify scripts to git pre-commit hooks.
# Note: The pre-commit hooks can be bypassed by using the flag --no-verify when
# performing a git commit.
git config --local core.hooksPath "${REPO_ROOT}/.githooks"
# TODO(verify): Reconcile with duplicate target
verify: ## Runs all verification tests.
${REPO_ROOT}/hack/verify.sh
# TODO(lint): Uncomment verify-shellcheck once we finish shellchecking the repo.
verify: tools verify-boilerplate verify-build verify-golangci-lint verify-go-mod #verify-shellcheck ## Runs verification scripts to ensure correct execution
verify-boilerplate: ## Runs the file header check
${REPO_ROOT}/hack/verify-boilerplate.sh
verify-build: ## Builds the project for a chosen set of platforms
${REPO_ROOT}/hack/verify-build.sh
verify-go-mod: ## Runs the go module linter
${REPO_ROOT}/hack/verify-go-mod.sh
verify-golangci-lint: ## Runs all golang linters
${REPO_ROOT}/hack/verify-golangci-lint.sh
verify-shellcheck: ## Runs shellcheck
${REPO_ROOT}/hack/verify-shellcheck.sh
verify-spelling: ## Verifies spelling.
${REPO_ROOT}/hack/verify-spelling.sh
##@ Tests
.PHONY: test test-go-unit test-go-integration
test: test-go-unit ## Runs unit tests
test-go-unit: ## Runs Golang unit tests
${REPO_ROOT}/hack/test-go.sh
test-go-integration: ## Runs Golang integration tests
${REPO_ROOT}/hack/test-go-integration.sh
##@ Tools
.PHONY: tools
WHAT ?= kepctl kepify
tools: ## Installs all KEP tools, can select via e.g. WHAT=kepctl
./compile-tools $(WHAT)
##@ Dependencies
.SILENT: update-deps update-deps-go update-mocks
.PHONY: update-deps update-deps-go update-mocks
update-deps: update-deps-go ## Update all dependencies for this repo
echo -e "${COLOR}Commit/PR the following changes:${NOCOLOR}"
git status --short
update-deps-go: GO111MODULE=on
update-deps-go: ## Update all golang dependencies for this repo
go get -u -t ./...
go mod tidy
go mod verify
$(MAKE) test-go-unit
${REPO_ROOT}/hack/update-all.sh
update-mocks: ## Update all generated mocks
go generate ./...
for f in $(shell find . -name fake_*.go); do \
cp hack/boilerplate/boilerplate.go.txt tmp ;\
sed -i.bak -e 's/YEAR/'$(shell date +"%Y")'/g' -- tmp && rm -- tmp.bak ;\
cat $$f >> tmp ;\
mv tmp $$f ;\
done
##@ Helpers
.PHONY: help
help: ## Display this help
@awk \
-v "col=${COLOR}" -v "nocol=${NOCOLOR}" \
' \
BEGIN { \
FS = ":.*##" ; \
printf "\nUsage:\n make %s<target>%s\n", col, nocol \
} \
/^[a-zA-Z_-]+:.*?##/ { \
printf " %s%-15s%s %s\n", col, $$1, nocol, $$2 \
} \
/^##@/ { \
printf "\n%s%s%s\n", col, substr($$0, 5), nocol \
} \
' $(MAKEFILE_LIST)