chore(Makefile): Give the help information of Makefile to make it mor… #65
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chore(Makefile): Give the help information of Makefile to make it more readable Signed-off-by: Xinwei Xiong <3293172751nss@gmail.com>
Signed-off-by: Xinwei Xiong <3293172751nss@gmail.com>
mouuii
reviewed
Mar 4, 2023
| # Set the default target to build all | ||
| .DEFAULT_GOAL := all | ||
|
|
||
| # Declare all targets as phony targets |
There was a problem hiding this comment.
Yes, I think the default help information is better
mouuii
reviewed
Mar 4, 2023
Makefile
Outdated
| @awk -F ':|##' '/^[^\.%\t][^\t]*:.*##/{printf " \033[36m%-20s\033[0m %s\n", $$1, $$NF}' $(MAKEFILE_LIST) | sort | ||
| @echo "Usage: \n" | ||
| @sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /' | ||
| .PHONY: help |
There was a problem hiding this comment.
why .PHONY is behind command
mouuii
reviewed
Mar 4, 2023
Makefile
Outdated
| ut: | ||
| sh .unit-test.sh | ||
|
|
||
| ## format: Run go fmt against code. |
mouuii
reviewed
Mar 4, 2023
Makefile
Outdated
| .PHONY: swagger | ||
| ## format: Gofmt (reformat) package sources (exclude vendor dir if existed). | ||
| .PHONY: format | ||
| format: tools.verify.golines tools.verify.goimports |
There was a problem hiding this comment.
no target tools.verify.golines
mouuii
reviewed
Mar 4, 2023
Makefile
Outdated
| .PHONY: swagger | ||
| ## format: Gofmt (reformat) package sources (exclude vendor dir if existed). | ||
| .PHONY: format | ||
| format: tools.verify.golines tools.verify.goimports |
There was a problem hiding this comment.
goimport include gofmt,so we use just goimport is ok.
SRC = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
imports:
@goimports -l -w $(SRC)
Also you can detect files which in git cache stage like below.
for file in $(git diff --cached --name-only --diff-filter ACM | grep "\.go" | grep -v -e "third_party" -e "Godeps"); do
# Check for files that fail gofmt.
diff="$(git show ":${file}" | gofmt -s -d)"
if [[ -n "$diff" ]]; then
files_need_gofmt="${files_need_gofmt} ${file}"
fi
done
|
Please retain the branch and I will resolve these issues before the branch life cycle ends |
kilosonc
reviewed
Mar 6, 2023
Makefile
Outdated
|
|
||
| .PHONY: swagger | ||
| ## format: Gofmt (reformat) package sources (exclude vendor dir if existed). | ||
| .PHONY: format |
There was a problem hiding this comment.
it is good to put .PHONY statement together
Makefile
Outdated
| swagger: | ||
| ifeq ($(shell uname -m),arm64) | ||
| docker build -t horizon-swagger -f build/swagger/Dockerfile . --platform linux/arm64 | ||
| else | ||
| docker build -t horizon-swagger -f build/swagger/Dockerfile . | ||
| endif | ||
|
|
||
| .PHONY: swagger-run | ||
| ## swagger-run: Run the swagger |
There was a problem hiding this comment.
Run a swagger server locally
…e readable Signed-off-by: Xinwei Xiong <3293172751nss@gmail.com>
Signed-off-by: Xinwei Xiong <3293172751nss@gmail.com>
kilosonc
approved these changes
Mar 9, 2023
| @echo "Comments:" | ||
| @echo "" | ||
| @awk -F ':|##' '/^[^\.%\t][^\t]*:.*##/{printf " \033[36m%-20s\033[0m %s\n", $$1, $$NF}' $(MAKEFILE_LIST) | sort | ||
| @sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /' |
| # Debugging info | ||
| *.debug | ||
| *.exe | ||
| *.test |
|
LGTM |
mouuii
approved these changes
Mar 9, 2023
iamyeka
approved these changes
Mar 14, 2023
|
I need to refer to this issue #100 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Xinwei Xiong 3293172751nss@gmail.com
Give the help information of Makefile to make it more readable, give some necessary lab