kind/Makefile

# Copyright 2019 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.

# Old-skool build tools.
# Simple makefile to build kind quickly and reproducibly in a container..
# Only requires docker on the host
#
# Common uses:
# - installing kind: `make install INSTALL_DIR=$HOME/go/bin`
# - building: `make build`
# - cleaning up and starting over: `make clean`

# get the repo root and output path, go_container.sh respects these
REPO_ROOT:=${CURDIR}
OUT_DIR=$(REPO_ROOT)/bin
INSTALL?=install
# make install will place binaries here
# the default path attempts to mimic go install
INSTALL_DIR?=$(shell hack/build/goinstalldir.sh)
# record the source commit in the binary
COMMIT?=$(shell git rev-parse HEAD 2>/dev/null)
LD_FLAGS:=-X sigs.k8s.io/kind/pkg/cmd/kind/version.GitCommit=$(COMMIT)
# the output binary name, overridden when cross compiling
KIND_BINARY_NAME?=kind
# the container cli to use e.g. docker,podman
DOCKER?=$(shell which docker || which podman || echo "docker")
export DOCKER
# standard "make" target -> builds
all: build
################################################################################
# ================================= Building ===================================
# builds kind in a container, outputs to $(OUT_DIR)
kind:
	hack/go_container.sh go build -v -o /out/$(KIND_BINARY_NAME) -ldflags "$(LD_FLAGS)"
# alias for building kind
build: kind
# use: make install INSTALL_DIR=/usr/local/bin
install: build
	$(INSTALL) -d $(INSTALL_DIR)
	$(INSTALL) $(OUT_DIR)/$(KIND_BINARY_NAME) $(INSTALL_DIR)/$(KIND_BINARY_NAME)
################################################################################
# ================================= Testing ====================================
# unit tests (hermetic)
unit:
	hack/ci/unit.sh
################################################################################
# ================================= Cleanup ====================================
# cleans the cache volume
clean-cache:
	$(DOCKER) volume rm -f kind-build-cache >/dev/null
# cleans the output directory
clean-output:
	rm -rf $(OUT_DIR)/
# standard cleanup target
clean: clean-output clean-cache
################################################################################
# ============================== Auto-Update ===================================
# update generated code, gofmt, etc.
update:
	hack/make-rules/update/all.sh
# update generated code
generate:
	hack/make-rules/update/generated.sh
# gofmt
gofmt:
	hack/make-rules/update/gofmt.sh
################################################################################
# ================================== Linting ===================================
# run linters, ensure generated code, etc.
verify:
	hack/make-rules/verify/all.sh
# code linters
lint:
	hack/make-rules/verify/lint.sh
# shell linter
shellcheck:
	hack/make-rules/verify/shellcheck.sh
#################################################################################
.PHONY: all kind build install clean-cache clean-output clean unit test lint shellcheck