219 lines
7.9 KiB
Makefile
219 lines
7.9 KiB
Makefile
#!/usr/bin/env bash
|
|
|
|
# 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
|
|
|
|
## --------------------------------------
|
|
## General
|
|
## --------------------------------------
|
|
|
|
SHELL:=/usr/bin/env bash
|
|
.DEFAULT_GOAL:=help
|
|
|
|
#
|
|
# Go.
|
|
#
|
|
GO_VERSION ?= 1.22.5
|
|
|
|
# Use GOPROXY environment variable if set
|
|
GOPROXY := $(shell go env GOPROXY)
|
|
ifeq ($(GOPROXY),)
|
|
GOPROXY := https://proxy.golang.org
|
|
endif
|
|
export GOPROXY
|
|
|
|
# Active module mode, as we use go modules to manage dependencies
|
|
export GO111MODULE=on
|
|
|
|
# Hosts running SELinux need :z added to volume mounts
|
|
SELINUX_ENABLED := $(shell cat /sys/fs/selinux/enforce 2> /dev/null || echo 0)
|
|
|
|
ifeq ($(SELINUX_ENABLED),1)
|
|
DOCKER_VOL_OPTS?=:z
|
|
endif
|
|
|
|
# Tools.
|
|
TOOLS_DIR := hack/tools
|
|
TOOLS_BIN_DIR := $(abspath $(TOOLS_DIR)/bin)
|
|
GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/golangci-lint)
|
|
GO_APIDIFF := $(TOOLS_BIN_DIR)/go-apidiff
|
|
CONTROLLER_GEN := $(TOOLS_BIN_DIR)/controller-gen
|
|
ENVTEST_DIR := $(abspath tools/setup-envtest)
|
|
SCRATCH_ENV_DIR := $(abspath examples/scratch-env)
|
|
GO_INSTALL := ./hack/go-install.sh
|
|
|
|
# The help will print out all targets with their descriptions organized bellow their categories. The categories are represented by `##@` and the target descriptions by `##`.
|
|
# The awk commands is responsible to read the entire set of makefiles included in this invocation, looking for lines of the file as xyz: ## something, and then pretty-format the target and help. Then, if there's a line with ##@ something, that gets pretty-printed as a category.
|
|
# More info over the usage of ANSI control characters for terminal formatting: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
|
|
# More info over awk command: http://linuxcommand.org/lc3_adv_awk.php
|
|
.PHONY: help
|
|
help: ## Display this help
|
|
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
|
|
|
## --------------------------------------
|
|
## Testing
|
|
## --------------------------------------
|
|
|
|
.PHONY: test
|
|
test: test-tools ## Run the script check-everything.sh which will check all.
|
|
TRACE=1 ./hack/check-everything.sh
|
|
|
|
.PHONY: test-tools
|
|
test-tools: ## tests the tools codebase (setup-envtest)
|
|
cd tools/setup-envtest && go test ./...
|
|
|
|
## --------------------------------------
|
|
## Binaries
|
|
## --------------------------------------
|
|
|
|
GO_APIDIFF_VER := v0.8.2
|
|
GO_APIDIFF_BIN := go-apidiff
|
|
GO_APIDIFF := $(abspath $(TOOLS_BIN_DIR)/$(GO_APIDIFF_BIN)-$(GO_APIDIFF_VER))
|
|
GO_APIDIFF_PKG := github.com/joelanford/go-apidiff
|
|
|
|
$(GO_APIDIFF): # Build go-apidiff from tools folder.
|
|
GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GO_APIDIFF_PKG) $(GO_APIDIFF_BIN) $(GO_APIDIFF_VER)
|
|
|
|
CONTROLLER_GEN_VER := v0.14.0
|
|
CONTROLLER_GEN_BIN := controller-gen
|
|
CONTROLLER_GEN := $(abspath $(TOOLS_BIN_DIR)/$(CONTROLLER_GEN_BIN)-$(CONTROLLER_GEN_VER))
|
|
CONTROLLER_GEN_PKG := sigs.k8s.io/controller-tools/cmd/controller-gen
|
|
|
|
$(CONTROLLER_GEN): # Build controller-gen from tools folder.
|
|
GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(CONTROLLER_GEN_PKG) $(CONTROLLER_GEN_BIN) $(CONTROLLER_GEN_VER)
|
|
|
|
GOLANGCI_LINT_BIN := golangci-lint
|
|
GOLANGCI_LINT_VER := $(shell cat .github/workflows/golangci-lint.yml | grep [[:space:]]version: | sed 's/.*version: //')
|
|
GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER))
|
|
GOLANGCI_LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
|
|
|
|
$(GOLANGCI_LINT): # Build golangci-lint from tools folder.
|
|
GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GOLANGCI_LINT_PKG) $(GOLANGCI_LINT_BIN) $(GOLANGCI_LINT_VER)
|
|
|
|
GO_MOD_CHECK_DIR := $(abspath ./hack/tools/cmd/gomodcheck)
|
|
GO_MOD_CHECK := $(abspath $(TOOLS_BIN_DIR)/gomodcheck)
|
|
GO_MOD_CHECK_IGNORE := $(abspath .gomodcheck.yaml)
|
|
.PHONY: $(GO_MOD_CHECK)
|
|
$(GO_MOD_CHECK): # Build gomodcheck
|
|
go build -C $(GO_MOD_CHECK_DIR) -o $(GO_MOD_CHECK)
|
|
|
|
## --------------------------------------
|
|
## Linting
|
|
## --------------------------------------
|
|
|
|
.PHONY: lint
|
|
lint: $(GOLANGCI_LINT) ## Lint codebase
|
|
$(GOLANGCI_LINT) run -v $(GOLANGCI_LINT_EXTRA_ARGS)
|
|
cd tools/setup-envtest; $(GOLANGCI_LINT) run -v $(GOLANGCI_LINT_EXTRA_ARGS)
|
|
|
|
.PHONY: lint-fix
|
|
lint-fix: $(GOLANGCI_LINT) ## Lint the codebase and run auto-fixers if supported by the linter.
|
|
GOLANGCI_LINT_EXTRA_ARGS=--fix $(MAKE) lint
|
|
|
|
## --------------------------------------
|
|
## Generate
|
|
## --------------------------------------
|
|
|
|
.PHONY: modules
|
|
modules: ## Runs go mod to ensure modules are up to date.
|
|
go mod tidy
|
|
cd $(TOOLS_DIR); go mod tidy
|
|
cd $(ENVTEST_DIR); go mod tidy
|
|
cd $(SCRATCH_ENV_DIR); go mod tidy
|
|
|
|
## --------------------------------------
|
|
## Release
|
|
## --------------------------------------
|
|
|
|
RELEASE_DIR := tools/setup-envtest/out
|
|
|
|
.PHONY: $(RELEASE_DIR)
|
|
$(RELEASE_DIR):
|
|
mkdir -p $(RELEASE_DIR)/
|
|
|
|
.PHONY: release
|
|
release: clean-release $(RELEASE_DIR) ## Build release.
|
|
@if ! [ -z "$$(git status --porcelain)" ]; then echo "Your local git repository contains uncommitted changes, use git clean before proceeding."; exit 1; fi
|
|
|
|
# Build binaries first.
|
|
$(MAKE) release-binaries
|
|
|
|
.PHONY: release-binaries
|
|
release-binaries: ## Build release binaries.
|
|
RELEASE_BINARY=setup-envtest-linux-amd64 GOOS=linux GOARCH=amd64 $(MAKE) release-binary
|
|
RELEASE_BINARY=setup-envtest-linux-arm64 GOOS=linux GOARCH=arm64 $(MAKE) release-binary
|
|
RELEASE_BINARY=setup-envtest-linux-ppc64le GOOS=linux GOARCH=ppc64le $(MAKE) release-binary
|
|
RELEASE_BINARY=setup-envtest-linux-s390x GOOS=linux GOARCH=s390x $(MAKE) release-binary
|
|
RELEASE_BINARY=setup-envtest-darwin-amd64 GOOS=darwin GOARCH=amd64 $(MAKE) release-binary
|
|
RELEASE_BINARY=setup-envtest-darwin-arm64 GOOS=darwin GOARCH=arm64 $(MAKE) release-binary
|
|
RELEASE_BINARY=setup-envtest-windows-amd64.exe GOOS=windows GOARCH=amd64 $(MAKE) release-binary
|
|
|
|
.PHONY: release-binary
|
|
release-binary: $(RELEASE_DIR)
|
|
docker run \
|
|
--rm \
|
|
-e CGO_ENABLED=0 \
|
|
-e GOOS=$(GOOS) \
|
|
-e GOARCH=$(GOARCH) \
|
|
-e GOCACHE=/tmp/ \
|
|
--user $$(id -u):$$(id -g) \
|
|
-v "$$(pwd):/workspace$(DOCKER_VOL_OPTS)" \
|
|
-w /workspace/tools/setup-envtest \
|
|
golang:$(GO_VERSION) \
|
|
go build -a -trimpath -ldflags "-extldflags '-static'" \
|
|
-o ./out/$(RELEASE_BINARY) ./
|
|
|
|
## --------------------------------------
|
|
## Cleanup / Verification
|
|
## --------------------------------------
|
|
|
|
.PHONY: clean
|
|
clean: ## Cleanup.
|
|
$(GOLANGCI_LINT) cache clean
|
|
$(MAKE) clean-bin
|
|
|
|
.PHONY: clean-bin
|
|
clean-bin: ## Remove all generated binaries.
|
|
rm -rf hack/tools/bin
|
|
|
|
.PHONY: clean-release
|
|
clean-release: ## Remove the release folder
|
|
rm -rf $(RELEASE_DIR)
|
|
|
|
.PHONY: verify-modules
|
|
verify-modules: modules $(GO_MOD_CHECK) ## Verify go modules are up to date
|
|
@if !(git diff --quiet HEAD -- go.sum go.mod $(TOOLS_DIR)/go.mod $(TOOLS_DIR)/go.sum $(ENVTEST_DIR)/go.mod $(ENVTEST_DIR)/go.sum $(SCRATCH_ENV_DIR)/go.sum); then \
|
|
git diff; \
|
|
echo "go module files are out of date, please run 'make modules'"; exit 1; \
|
|
fi
|
|
$(GO_MOD_CHECK) $(GO_MOD_CHECK_IGNORE)
|
|
|
|
APIDIFF_OLD_COMMIT ?= $(shell git rev-parse origin/main)
|
|
|
|
.PHONY: apidiff
|
|
verify-apidiff: $(GO_APIDIFF) ## Check for API differences
|
|
$(GO_APIDIFF) $(APIDIFF_OLD_COMMIT) --print-compatible
|
|
|
|
## --------------------------------------
|
|
## Helpers
|
|
## --------------------------------------
|
|
|
|
##@ helpers:
|
|
|
|
go-version: ## Print the go version we use to compile our binaries and images
|
|
@echo $(GO_VERSION)
|