feat(makefile improvements): add help, desc of targets and their prerequirements steps

Author: camilamacedo86

Makefile

@@ -17,29 +17,63 @@
 #
 # Makefile with some common workflow for dev, build and test
 #
+export GOPROXY?=https://proxy.golang.org/
+CONTROLLER_GEN_BIN_PATH := $(shell which controller-gen)
 
-all: build test
+##@ General
 
-.PHONY: build test
+# The help will print out all targets with their descriptions organized bellow their categories. The categories are represented by `##@` and the target descriptions by `##`.
+# The awk commands is responsable to read the entire set of makefiles included in this invocation, looking for lines of the file as xyz: ## something, and then pretty-format the target and help. Then, if there's a line with ##@ something, that gets pretty-printed as a category.
+# More info over the usage of ANSI control characters for terminal formatting: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
+# More info over awk command: http://linuxcommand.org/lc3_adv_awk.php
+.PHONY: help
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-build:
+##@ Build
+
+.PHONY: build
+build: ## Build the project locally
 	go build -o bin/kubebuilder ./cmd
 
-install: build
+.PHONY: install
+install: ## Build and install the binary with the current source code. Use it to test your changes locally.
+	make build
 	cp ./bin/kubebuilder $(shell go env GOPATH)/bin/kubebuilder
 
-generate:
+##@ Development
+
+.PHONY: generate
+generate: ## Update/generate all mock data. You should run this commands to update the mock data after your changes.
+	make generate-vendor
+	make generate-setup
+	make generate-testdata
+
+.PHONY: generate-testdata
+generate-testdata: ## Update/generate the testdata in $GOPATH/src/sigs.k8s.io/kubebuilder
 	GO111MODULE=on ./generated_golden.sh
 
+.PHONY: generate-vendor
+generate-vendor: ## Update/generate the vendor by using the path $GOPATH/src/sigs.k8s.io/kubebuilder-test
+	GO111MODULE=off ./generate_vendor.sh
+
+.PHONY: generate-setup
+generate-setup: ## Current workarround to generate the testdata with the correct controller-gen version
+	- rm -rf $(CONTROLLER_GEN_BIN_PATH)
+	- GO111MODULE=on go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.2.1
+
+##@ Tests
+
 .PHONY: test
-test:
+test: ## Run the go tests ($ go test -v ./cmd/... ./pkg/...)
 	go test -v ./cmd/... ./pkg/...
 
 .PHONY: test-project-generation
-test-project-generation:
+test-project-generation: ## Run the unit tests (used in the CI)
+	- go get sigs.k8s.io/kind@v0.5.1
 	./test.sh
 
 .PHONY: test-e2e
-test-e2e:
+test-e2e: ## Run the integration tests (used in the CI)
 	./test_e2e_v1.sh
 	./test_e2e_v2.sh