Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds help command #1622

Merged
merged 3 commits into from
Oct 14, 2021
Merged

Adds help command #1622

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ebe433
Adds help command
Oct 12, 2021
533cc08
Makes changes
Oct 13, 2021
f16b43e
Updates make file
Oct 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions Makefile
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work on vanilla OSX and Linux with no additional tools?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested this with Ubuntu, Mac Os without installing any additional tool.

@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)