Skip to content

Commit 7e4f490

Browse files
6543techknowlogick
andcommitted
[Docs] introduce "make help" (#9604)
* introduce "make help" * fix + add more routienes * Update Makefile * add make vet Co-authored-by: techknowlogick <[email protected]>
1 parent 444c3a1 commit 7e4f490

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Makefile

+19
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,25 @@ all: build
9292

9393
include docker/Makefile
9494

95+
.PHONY: help
96+
help:
97+
@echo "Make Routines:"
98+
@echo " - \"\" equivalent to \"build\""
99+
@echo " - build creates the entire project"
100+
@echo " - clean delete integration files and build files but not css and js files"
101+
@echo " - clean-all delete all generated files (integration test, build, css and js files)"
102+
@echo " - css rebuild only css files"
103+
@echo " - js rebuild only js files"
104+
@echo " - generate run \"make css js\" and \"go generate\""
105+
@echo " - fmt format the code"
106+
@echo " - generate-swagger generate the swagger spec from code comments"
107+
@echo " - swagger-validate check if the swagger spec is valide"
108+
@echo " - revive run code linter revive"
109+
@echo " - misspell check if a word is written wrong"
110+
@echo " - vet examines Go source code and reports suspicious constructs"
111+
@echo " - test run unit test"
112+
@echo " - test-sqlite run integration test for sqlite"
113+
95114
.PHONY: go-check
96115
go-check:
97116
$(eval GO_VERSION := $(shell printf "%03d%03d%03d" $(shell go version | grep -Eo '[0-9]+\.?[0-9]+?\.?[0-9]?\s' | tr '.' ' ');))

0 commit comments

Comments
 (0)