Skip to content

Commit aeb637b

Browse files
authored
Improves 'make help' documentation (kubeflow#573)
Signed-off-by: Alex Creasy <[email protected]>
1 parent 5a8af71 commit aeb637b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

clients/ui/bff/Makefile

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,41 @@ help: ## Display this help.
1616
@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)
1717

1818
.PHONY: fmt
19-
fmt:
19+
fmt: ## Applies the correct code style to source files using go fmt.
2020
go fmt ./...
2121

22-
.PHONY: clean
22+
.PHONY: clean ## Deletes previously built binaries.
2323
clean:
2424
rm -Rf ./bin
2525

2626
.PHONY: lint
27-
lint: golangci-lint ## Run golangci-lint linter
27+
lint: golangci-lint ## Run golangci-lint to automatically check source code for programmatic and stylistic errors.
2828
$(GOLANGCI_LINT) run
2929

3030
.PHONY: lint-fix
31-
lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
31+
lint-fix: golangci-lint ## Run golangci-lint to automatically check source code for programmatic and stylistic errors and, additionally perform fixes where possible.
3232
$(GOLANGCI_LINT) run --fix
3333

3434
.PHONY: vet
35-
vet: .
35+
vet: . ## Runs static analysis tools on source files and reports suspicious constructs that could be bugs or syntactical errors.
3636
go vet ./...
3737

3838
.PHONY: test
39-
test: fmt vet envtest
39+
test: fmt vet envtest ## Runs the full test suite.
4040
ENVTEST_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" \
4141
go test ./...
4242

4343
.PHONY: build
44-
build: fmt vet test
44+
build: fmt vet test ## Builds the project to produce a binary executable.
4545
go build -o bin/bff cmd/main.go
4646

4747
.PHONY: run
48-
run: fmt vet envtest
48+
run: fmt vet envtest ## Runs the project.
4949
ENVTEST_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" \
5050
go run ./cmd/main.go --port=$(PORT) --mock-k8s-client=$(MOCK_K8S_CLIENT) --mock-mr-client=$(MOCK_MR_CLIENT) --dev-mode=$(DEV_MODE) --dev-mode-port=$(DEV_MODE_PORT)
5151

5252
.PHONY: docker-build
53-
docker-build:
53+
docker-build: ## Builds a container for the project.
5454
$(CONTAINER_TOOL) build -t ${IMG} .
5555

5656
##@ Dependencies

0 commit comments

Comments
 (0)