Makefile help #246
Merged
Makefile help #246
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Document developer facing make targets in convenient `make help` * Inspired by https://victoria.dev/blog/how-to-create-a-self-documenting-makefile/ Looks like this: ``` $ make help debug-test-etcd Run temporary etcd pod for debug demo-failover Execute failover demo demo-roundrobin Execute round-robin demo deploy-full-local-setup Deploy full local multicluster setup deploy-gslb-cr Apply Gslb Custom Resources deploy-gslb-operator Deploy k8gb operator deploy-test-apps Deploy testing workloads destroy-full-local-setup Destroy full local multicluster setup dns-tools Run temporary dnstools pod for debugging DNS issues help Show this help ``` Signed-off-by: Yury Tsarev <[email protected]>
ytsarev
requested review from
donovanmuller,
k0da,
kuritka and
somaritane
as code owners
donovanmuller
approved these changes
Jan 10, 2021
kuritka
approved these changes
Jan 10, 2021
|
good idea 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
make helpLooks like this:
Signed-off-by: Yury Tsarev [email protected]