chore: add make help cmd

Signed-off-by: yyzxw <[email protected]>
pingcap · Jun 27, 2023 · 8fd35bf · 8fd35bf
1 parent 9ae7cc6
commit 8fd35bf
Showing 1 changed file with 69 additions and 39 deletions.
diff --git a/Makefile b/Makefile
@@ -33,12 +33,9 @@ GO_TEST := $(GO) test -cover -covermode=atomic -coverpkg=$$($(TEST_COVER_PACKAGE
 
 default: build
 
-docker-push: docker
-	docker push "${DOCKER_REPO}/tidb-operator:${IMAGE_TAG}"
-	docker push "${DOCKER_REPO}/tidb-backup-manager:${IMAGE_TAG}"
-	docker push "${DOCKER_REPO}/br-federation-manager:${IMAGE_TAG}"
 
-docker: operator-docker backup-docker br-federation-docker
+
+
 
 ifeq ($(NO_BUILD),y)
 operator-docker:
@@ -54,53 +51,63 @@ endif
 
 build: controller-manager scheduler discovery admission-webhook backup-manager br-federation-manager
 
-controller-manager:
+##@ Build
+
+controller-manager: ## Build tidb-controller-manager binary
 ifeq ($(E2E),y)
 	$(GO_TEST) -ldflags '$(LDFLAGS)' -c -o images/tidb-operator/bin/tidb-controller-manager ./cmd/controller-manager
 else
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o images/tidb-operator/bin/$(GOARCH)/tidb-controller-manager cmd/controller-manager/main.go
 endif
 
-scheduler:
+scheduler: ## Build tidb-scheduler binary
 ifeq ($(E2E),y)
 	$(GO_TEST) -ldflags '$(LDFLAGS)' -c -o images/tidb-operator/bin/tidb-scheduler ./cmd/scheduler
 else
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o images/tidb-operator/bin/$(GOARCH)/tidb-scheduler cmd/scheduler/main.go
 endif
 
-discovery:
+discovery: ## Build tidb-discovery binary
 ifeq ($(E2E),y)
 	$(GO_TEST) -ldflags '$(LDFLAGS)' -c -o images/tidb-operator/bin/tidb-discovery ./cmd/discovery
 else
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o images/tidb-operator/bin/$(GOARCH)/tidb-discovery cmd/discovery/main.go
 endif
 
-admission-webhook:
+admission-webhook: ## Build tidb-admission-webhook binary
 ifeq ($(E2E),y)
 	$(GO_TEST) -ldflags '$(LDFLAGS)' -c -o images/tidb-operator/bin/tidb-admission-webhook ./cmd/admission-webhook
 else
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o images/tidb-operator/bin/$(GOARCH)/tidb-admission-webhook cmd/admission-webhook/main.go
 endif
 
-backup-manager:
+backup-manager: ## Build tidb-backup-manager binary
 ifeq ($(E2E),y)
 	$(GO_TEST) -ldflags '$(LDFLAGS)' -c -o images/tidb-backup-manager/bin/tidb-backup-manager ./cmd/backup-manager
 else
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o images/tidb-backup-manager/bin/$(GOARCH)/tidb-backup-manager cmd/backup-manager/main.go
 endif
 
-br-federation-manager:
+br-federation-manager: ## Build br-federation-manager binary
 ifeq ($(E2E),y)
 	$(GO_TEST) -ldflags '$(LDFLAGS)' -c -o images/br-federation-manager/bin/br-federation-manager ./cmd/br-federation-manager
 else
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o images/br-federation-manager/bin/$(GOARCH)/br-federation-manager ./cmd/br-federation-manager
 endif
 
+##@ Build Docker images
+docker: operator-docker backup-docker br-federation-docker
+
+docker-push: docker ## Push Docker images to registry
+	docker push "${DOCKER_REPO}/tidb-operator:${IMAGE_TAG}"
+	docker push "${DOCKER_REPO}/tidb-backup-manager:${IMAGE_TAG}"
+	docker push "${DOCKER_REPO}/br-federation-manager:${IMAGE_TAG}"
+
 ifeq ($(NO_BUILD),y)
 backup-docker:
 	@echo "NO_BUILD=y, skip build for $@"
 else
-backup-docker: backup-manager
+backup-docker: backup-manager ## Build tidb-backup-manager image
 endif
 ifeq ($(E2E),y)
 	docker build --tag "${DOCKER_REPO}/tidb-backup-manager:${IMAGE_TAG}" -f images/tidb-backup-manager/Dockerfile.e2e images/tidb-backup-manager
@@ -112,22 +119,22 @@ ifeq ($(NO_BUILD),y)
 br-federation-docker:
 	@echo "NO_BUILD=y, skip build for $@"
 else
-br-federation-docker: br-federation-manager
+br-federation-docker: br-federation-manager ## Build br-federation-manager image
 endif
 ifeq ($(E2E),y)
 	docker build --tag "${DOCKER_REPO}/br-federation-manager:${IMAGE_TAG}" -f images/br-federation-manager/Dockerfile.e2e images/br-federation-manager
 else
 	docker build --tag "${DOCKER_REPO}/br-federation-manager:${IMAGE_TAG}" --build-arg=TARGETARCH=$(GOARCH) images/br-federation-manager
 endif
 
-e2e-docker-push: e2e-docker
+e2e-docker-push: e2e-docker ## Push tidb-operator-e2e image to registry
 	docker push "${DOCKER_REPO}/tidb-operator-e2e:${IMAGE_TAG}"
 
 ifeq ($(NO_BUILD),y)
 e2e-docker:
 	@echo "NO_BUILD=y, skip build for $@"
 else
-e2e-docker: e2e-build
+e2e-docker: e2e-build ## Build tidb-operator-e2e image
 endif
 	[ -d tests/images/e2e/tidb-operator ] && rm -r tests/images/e2e/tidb-operator || true
 	[ -d tests/images/e2e/tidb-cluster ] && rm -r tests/images/e2e/tidb-cluster || true
@@ -140,15 +147,29 @@ endif
 	cp -r manifests tests/images/e2e
 	docker build -t "${DOCKER_REPO}/tidb-operator-e2e:${IMAGE_TAG}" tests/images/e2e
 
-e2e-build:
+e2e-build: ## Build binaries for test
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o tests/images/e2e/bin/ginkgo github.com/onsi/ginkgo/ginkgo
 	$(GO_TEST) -c -ldflags '$(LDFLAGS)' -o tests/images/e2e/bin/e2e.test ./tests/e2e
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o tests/images/e2e/bin/webhook ./tests/cmd/webhook
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o tests/images/e2e/bin/blockwriter ./tests/cmd/blockwriter
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o tests/images/e2e/bin/mock-prometheus ./tests/cmd/mock-monitor
 
-e2e:
-	./hack/e2e.sh
+
+debug-docker-push: debug-build-docker
+	docker push "${DOCKER_REPO}/debug-launcher:latest"
+	docker push "${DOCKER_REPO}/tidb-control:latest"
+	docker push "${DOCKER_REPO}/tidb-debug:latest"
+
+debug-build-docker: debug-build
+	docker build -t "${DOCKER_REPO}/debug-launcher:latest" misc/images/debug-launcher
+	docker build -t "${DOCKER_REPO}/tidb-control:latest" misc/images/tidb-control
+	docker build -t "${DOCKER_REPO}/tidb-debug:latest" misc/images/tidb-debug
+
+debug-build: ## Build binaries for debug
+	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o misc/images/debug-launcher/bin/debug-launcher misc/cmd/debug-launcher/main.go
+
+kubekins-e2e-docker:
+	docker build -t "${DOCKER_REPO}/kubekins-e2e:latest" tests/images/kubekins-e2e
 
 e2e-examples:
 	./hack/e2e-examples.sh
@@ -159,6 +180,8 @@ gocovmerge:
 fault-trigger:
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o tests/images/fault-trigger/bin/fault-trigger tests/cmd/fault-trigger/*.go
 
+##@ Tests
+
 # ARGS:
 #
 # GOFLAGS: Extra flags to pass to 'go' when building, e.g.
@@ -167,7 +190,7 @@ fault-trigger:
 # GO_COVER: Whether to run tests with code coverage. Set to 'y' to enable coverage collection.
 #
 test: TEST_PACKAGES = ./cmd/backup-manager/app ./pkg
-test:
+test: ## Run unit tests
 	@echo "Run unit tests"
 ifeq ($(GO_COVER),y)
 	go test -cover \
@@ -181,47 +204,54 @@ else
 endif
 	@echo -e "\nUnit tests run successfully!"
 
+e2e: ## Run e2e tests
+	./hack/e2e.sh
+
+##@ Development
+
 ALL_CHECKS = EOF codegen crd boilerplate openapi-spec api-references spelling modules lint
 check: $(addprefix check-,$(ALL_CHECKS)) tidy
 
-check-%:
+check-%: ## Check code style, spelling and lint
 	./hack/verify-$*.sh
 
-generate:
+generate: ## Generate code
 	./hack/update-all.sh
 
-crd:
+crd: ## Generate CRD manifests
 	./hack/update-crd.sh
 
-api-references:
+api-references: ## Generate API references
 	./hack/update-api-references.sh
 
-tidy:
+tidy: ## Run go mod tidy and verify the result
 	@echo "go mod tidy"
 	go mod tidy && git diff -U --exit-code go.mod go.sum
 	cd pkg/apis && go mod tidy && git diff -U --exit-code go.mod go.sum
 	cd pkg/client && go mod tidy && git diff -U --exit-code go.mod go.sum
 
-cli:
+cli: ## Build tkctl
 	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o tkctl cmd/tkctl/main.go
 
-debug-docker-push: debug-build-docker
-	docker push "${DOCKER_REPO}/debug-launcher:latest"
-	docker push "${DOCKER_REPO}/tidb-control:latest"
-	docker push "${DOCKER_REPO}/tidb-debug:latest"
 
-debug-build-docker: debug-build
-	docker build -t "${DOCKER_REPO}/debug-launcher:latest" misc/images/debug-launcher
-	docker build -t "${DOCKER_REPO}/tidb-control:latest" misc/images/tidb-control
-	docker build -t "${DOCKER_REPO}/tidb-debug:latest" misc/images/tidb-debug
-
-debug-build:
-	$(GO_BUILD) -ldflags '$(LDFLAGS)' -o misc/images/debug-launcher/bin/debug-launcher misc/cmd/debug-launcher/main.go
-
-kubekins-e2e-docker:
-	docker build -t "${DOCKER_REPO}/kubekins-e2e:latest" tests/images/kubekins-e2e
+##@ Release
 
 docker-release:
 	docker buildx build --platform linux/amd64,linux/arm64 --push -t "$(DOCKER_REPO)/tidb-operator:$(IMAGE_TAG)" --build-arg "GOPROXY=$(shell go env GOPROXY)" --build-arg "LDFLAGS=$(LDFLAGS)" -f images/tidb-operator/Dockerfile.new .
 
 .PHONY: check check-setup build e2e-build debug-build cli e2e gocovmerge test docker e2e-docker debug-build-docker
+
+# The help target prints out all targets with their descriptions organized
+# beneath their categories. The categories are represented by '##@' and the
+# target descriptions by '##'. The awk commands is responsible for reading 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 on the usage of ANSI control characters for terminal formatting:
+# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
+# More info on the 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)