From b325cb007d7a5410558fbc9afa8cc778c0c7591f Mon Sep 17 00:00:00 2001 From: Hasmukh K Mistry Date: Thu, 14 Oct 2021 14:51:14 +0530 Subject: [PATCH] Adds help command (#1622) * 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 * Makes changes Makes changes based on suggestions Signed-off-by: Hasmukh K Mistry * Updates make file Removes unused target from makefile Signed-off-by: Hasmukh K Mistry Co-authored-by: Hasmukh K Mistry --- Makefile | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index 9dfe4cbc1d..7f71d6a6b1 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 @@ -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\033[0m\n\nTargets:\n"} /^[0-9a-zA-Z_-]+:.*?##/ { printf " \033[36m%-20s\033[0m %s\n", $$1, $$2 } ' $(MAKEFILE_LIST) \ No newline at end of file