Skip to content

Commit 3eb11da

Browse files
committed
docs: improve help comments in make
Signed-off-by: Mateusz Urbanek <[email protected]>
1 parent edf85cd commit 3eb11da

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

Makefile

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ vet: vet.client vet.controller vet.sidecar ## Vet code
7171
test: .test.proto test.client test.controller test.sidecar ## Run tests including unit tests
7272

7373
.PHONY: test-e2e
74-
test-e2e: chainsaw # Run e2e tests
74+
test-e2e: chainsaw # Run e2e tests against the K8s cluster specified in ~/.kube/config. It requires both controller and driver deployed. If you need to create a cluster beforehand, consider using 'cluster' and 'deploy' targets.
7575
$(CHAINSAW) test --values ./test/e2e/values.yaml
7676

7777
.PHONY: lint
@@ -145,17 +145,13 @@ cluster: kind ctlptl ## Create Kind cluster and local registry
145145
cluster-reset: kind ctlptl ## Delete Kind cluster
146146
$(CTLPTL) delete -f ctlptl.yaml
147147

148-
ifndef ignore-not-found
149-
ignore-not-found = false
150-
endif
151-
152148
.PHONY: deploy
153-
deploy: .gen kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
149+
deploy: kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. The 'generate' and 'codegen' targets should be run manually, and are expected to be run at least once before the 'deploy' target, as those are not cached.
154150
$(KUSTOMIZE) build . | $(KUBECTL) apply -f -
155151

156152
.PHONY: undeploy
157-
undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
158-
$(KUSTOMIZE) build . | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
153+
undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
154+
$(KUSTOMIZE) build . | $(KUBECTL) delete --ignore-not-found=true -f -
159155

160156
##@ Tools
161157

0 commit comments

Comments
 (0)