Skip to content

Commit

Permalink
Adds help command (flyteorg#1622)
Browse files Browse the repository at this point in the history
* Adds help command

Introduces help command in makefile. Adds comments along with make targets to display in make help section.

Signed-off-by: Hasmukh K Mistry <[email protected]>

* Makes changes

Makes changes based on suggestions

Signed-off-by: Hasmukh K Mistry <[email protected]>

* Updates make file

Removes unused target from makefile

Signed-off-by: Hasmukh K Mistry <[email protected]>

Co-authored-by: Hasmukh K Mistry <[email protected]>
  • Loading branch information
hasukmistry and Hasmukh K Mistry authored Oct 14, 2021
1 parent 61be03c commit b325cb0
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ kustomize:
KUSTOMIZE_VERSION=3.9.2 bash script/generate_kustomize.sh

.PHONY: helm
helm:
helm: ## Generate K8s Manifest from Helm Charts.
bash script/generate_helm.sh

.PHONY: release_automation
Expand All @@ -22,21 +22,15 @@ release_automation:
bash script/release.sh

.PHONY: deploy_sandbox
deploy_sandbox:
deploy_sandbox:
bash script/deploy.sh

# launch dockernetes and execute tests
.PHONY: end2end
end2end:
@end2end/launch_dockernetes.sh

# execute tests in the current kubernetes context
.PHONY: end2end_execute
end2end_execute:
end2end_execute: ## Execute tests in the current kubernetes context
@end2end/execute.sh

.PHONY: install-piptools
install-piptools:
install-piptools: ## Install pip-tools
pip install -U pip-tools

.PHONY: doc-requirements.txt
Expand All @@ -58,17 +52,22 @@ prepare_artifacts:
bash script/prepare_artifacts.sh

.PHONE: helm_update
helm_update:
helm_update: ## Update helm charts' dependencies.
helm dep update ./charts/flyte/

.PHONY: helm_install
helm_install:
helm_install: ## Install helm charts
helm install flyte --debug ./charts/flyte -f ./charts/flyte/values-sandbox.yaml --create-namespace --namespace=flyte

.PHONY: helm_upgrade
helm_upgrade:
helm_upgrade: ## Upgrade helm charts
helm upgrade flyte --debug ./charts/flyte -f ./charts/flyte/values-sandbox.yaml --create-namespace --namespace=flyte

.PHONY: docs
docs:
make -C rsts clean html SPHINXOPTS=-W

.PHONY: help
help: SHELL := /bin/sh
help: ## List available commands and their usage
@awk 'BEGIN {FS = ":.*?##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n\nTargets:\n"} /^[0-9a-zA-Z_-]+:.*?##/ { printf " \033[36m%-20s\033[0m %s\n", $$1, $$2 } ' $(MAKEFILE_LIST)

0 comments on commit b325cb0

Please sign in to comment.