Skip to content

Commit 5107960

Browse files
authored
Clean up the Makefile help and extended help (#1810)
Signed-off-by: Todd Short <[email protected]>
1 parent b2bf895 commit 5107960

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

Makefile

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ KUSTOMIZE_BUILD_DIR := config/overlays/cert-manager
8787

8888
.PHONY: help
8989
help: #HELP Display essential help.
90-
@awk 'BEGIN {FS = ":[^#]*#HELP"; printf "\nUsage:\n make \033[36m<target>\033[0m\n\n"} /^[a-zA-Z_0-9-]+:.*#HELP / { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } ' $(MAKEFILE_LIST)
90+
@awk 'BEGIN {FS = ":[^#]*#HELP"; printf "\nUsage:\n make \033[36m<target>\033[0m\n\n"} /^[a-zA-Z_0-9-]+:.*#HELP / { printf " \033[36m%-17s\033[0m %s\n", $$1, $$2 } ' $(MAKEFILE_LIST)
9191

9292
.PHONY: help-extended
9393
help-extended: #HELP Display extended help.
@@ -100,11 +100,11 @@ lint: lint-custom $(GOLANGCI_LINT) #HELP Run golangci linter.
100100
$(GOLANGCI_LINT) run --build-tags $(GO_BUILD_TAGS) $(GOLANGCI_LINT_ARGS)
101101

102102
.PHONY: custom-linter-build
103-
custom-linter-build: #HELP Build custom linter
103+
custom-linter-build: #EXHELP Build custom linter
104104
go build -tags $(GO_BUILD_TAGS) -o ./bin/custom-linter ./hack/ci/custom-linters/cmd
105105

106106
.PHONY: lint-custom
107-
lint-custom: custom-linter-build #HELP Call custom linter for the project
107+
lint-custom: custom-linter-build #EXHELP Call custom linter for the project
108108
go vet -tags=$(GO_BUILD_TAGS) -vettool=./bin/custom-linter ./...
109109

110110
.PHONY: tidy
@@ -166,6 +166,8 @@ verify-crd-compatibility: $(CRD_DIFF) manifests
166166
$(CRD_DIFF) --config="${CRD_DIFF_CONFIG}" "${CRD_DIFF_ORIGINAL_REF}${CRD_DIFF_OPCON_SOURCE}" ${CRD_DIFF_UPDATED_REF}${CRD_DIFF_OPCON_SOURCE}
167167
$(CRD_DIFF) --config="${CRD_DIFF_CONFIG}" "${CRD_DIFF_ORIGINAL_REF}${CRD_DIFF_CATD_SOURCE}" ${CRD_DIFF_UPDATED_REF}${CRD_DIFF_CATD_SOURCE}
168168

169+
#SECTION Test
170+
169171
.PHONY: test
170172
test: manifests generate fmt lint test-unit test-e2e #HELP Run all tests.
171173

@@ -231,9 +233,9 @@ test-e2e: run image-registry e2e e2e-coverage kind-clean #HELP Run e2e test suit
231233

232234
.PHONY: extension-developer-e2e
233235
extension-developer-e2e: KUSTOMIZE_BUILD_DIR := config/overlays/cert-manager
234-
extension-developer-e2e: KIND_CLUSTER_NAME := operator-controller-ext-dev-e2e #EXHELP Run extension-developer e2e on local kind cluster
235-
extension-developer-e2e: export INSTALL_DEFAULT_CATALOGS := false #EXHELP Run extension-developer e2e on local kind cluster
236-
extension-developer-e2e: run image-registry test-ext-dev-e2e kind-clean
236+
extension-developer-e2e: KIND_CLUSTER_NAME := operator-controller-ext-dev-e2e
237+
extension-developer-e2e: export INSTALL_DEFAULT_CATALOGS := false
238+
extension-developer-e2e: run image-registry test-ext-dev-e2e kind-clean #EXHELP Run extension-developer e2e on local kind cluster
237239

238240
.PHONY: run-latest-release
239241
run-latest-release:
@@ -257,6 +259,8 @@ test-upgrade-e2e: kind-cluster run-latest-release image-registry pre-upgrade-set
257259
e2e-coverage:
258260
COVERAGE_OUTPUT=./coverage/e2e.out ./hack/test/e2e-coverage.sh
259261

262+
#SECTION KIND Cluster Operations
263+
260264
.PHONY: kind-load
261265
kind-load: $(KIND) #EXHELP Loads the currently constructed images into the KIND cluster.
262266
$(CONTAINER_RUNTIME) save $(IMG) | $(KIND) load image-archive /dev/stdin --name $(KIND_CLUSTER_NAME)

0 commit comments

Comments
 (0)