Add make help target (#108)

tanaka0325 · web-flow · commit 08b8eac13cab · 2022-06-13T11:14:10.000-06:00
Closes #101. Signed-off-by: Hiroyuki Tanaka <h.tanaka.0325@gmail.com>
diff --git a/DEVELOPER.md b/DEVELOPER.md
@@ -10,7 +10,7 @@ build system. Our CI is based on [Github Actions](https://docs.github.com/en/act
 * Installation Guide: https://go.dev/doc/install to
 
 ### make
-* Recommended Version: 4.3 
+* Recommended Version: 4.3
 * Installation Guide: https://www.gnu.org/software/make/).
 
 ### docker
@@ -27,5 +27,4 @@ preinstalled tools needed to support all the `make` targets.
 
 ## Quick start
 
-[TODO](https://github.com/envoyproxy/gateway/issues/101) Run `make help` to see all the available targets to build, test
-and run `envoy-gateway`.
+Run `make help` to see all the available targets to build, test and run `envoy-gateway`.
diff --git a/Makefile.targets.mk b/Makefile.targets.mk
@@ -30,9 +30,16 @@ test:
 
 .PHONY: docker-build
 docker-build: build-all ## Build the envoy-gateway docker image.
-	@DOCKER_BUILDKIT=1 docker build -t $(IMAGE):$(TAG) -f Dockerfile bin 
+	@DOCKER_BUILDKIT=1 docker build -t $(IMAGE):$(TAG) -f Dockerfile bin
 
 .PHONY: docker-push
 docker-push: ## Push the docker image for envoy-gateway.
 	@docker push $(IMAGE):$(TAG)
 
+.PHONY: help
+help: ## Display this help
+	@echo Envoy Gateway is an open source project for managing Envoy Proxy as a standalone or Kubernetes-based application gateway
+	@echo
+	@echo Targets:
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9._-]+:.*?## / {printf "  %-25s %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
+
