Conversation
alpeb
left a comment
alpeb
left a comment
There was a problem hiding this comment.
make makes sense to me 😄
Is there a way to add some kind of help string or something into the Makefile to advise people the series of targets to be run (e.g. build, kind-load, integration-test)? I understand we shouldn't make those dependent on one another given this wouldn't necessary be run in KinD, but some way of stating that dependency on the KinD scenario would be helpful.
|
@alpeb I add some help text. Is that ok?
|
Makefile
Outdated
|
|
||
| .PHONY: help | ||
| help: ## Show this help | ||
| @echo 'Info: For integration test using KinD, run: make kind-load && make integration-test' |
There was a problem hiding this comment.
Awesome! I believe make kind-load integration-test is enough, no?
There was a problem hiding this comment.
ah yes, you are right
Makefile
Outdated
| .PHONY: help | ||
| help: ## Show this help | ||
| @echo 'Info: For integration test using KinD, run: make kind-load && make integration-test' | ||
| @echo 'Info: For integration test using minikube, run: make integration-test' |
There was a problem hiding this comment.
I think you can just say something like "For other environments, run make integration-test after having uploaded the images" given this might be run in other places like cloud environments.
| help: ## Show this help | ||
| @echo 'Info: For integration test using KinD, run: make kind-load && make integration-test' | ||
| @echo 'Info: For integration test using minikube, run: make integration-test' | ||
| @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' |
There was a problem hiding this comment.
Loved this technique, I'm gonna steal it 🙂
There was a problem hiding this comment.
😄
I got it from here https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
@aliariff would you mind rebasing from master so that the lint checks pass? We should be able to merge after that |
Signed-off-by: Ali Ariff <ali.ariff12@gmail.com>
Signed-off-by: Ali Ariff <ali.ariff12@gmail.com>
Signed-off-by: Ali Ariff <ali.ariff12@gmail.com>
Signed-off-by: Ali Ariff <ali.ariff12@gmail.com>
Signed-off-by: Ali Ariff <ali.ariff12@gmail.com>
3 participants
No description provided.