2022-05-02 03:02:05 +00:00
|
|
|
# NOTE: this Makefile is meant to provide a simplified entry point for humans to
|
|
|
|
|
# run all of the critical steps to verify one's changes are harmonious in
|
|
|
|
|
# nature. Keeping target bodies to one line each and abstaining from make magic
|
|
|
|
|
# are very important so that maintainers and contributors can focus their
|
|
|
|
|
# attention on files that are primarily Go.
|
|
|
|
|
|
2022-09-11 16:43:29 +00:00
|
|
|
GO_RUN_BUILD := go run internal/build/build.go
|
|
|
|
|
|
2022-05-02 03:02:05 +00:00
|
|
|
.PHONY: all
|
2022-10-13 12:15:14 +00:00
|
|
|
all: generate vet test check-binary-size gfmrun yamlfmt
|
2022-05-02 03:02:05 +00:00
|
|
|
|
2022-05-04 14:32:29 +00:00
|
|
|
# NOTE: this is a special catch-all rule to run any of the commands
|
|
|
|
|
# defined in internal/build/build.go with optional arguments passed
|
|
|
|
|
# via GFLAGS (global flags) and FLAGS (command-specific flags), e.g.:
|
|
|
|
|
#
|
|
|
|
|
# $ make test GFLAGS='--packages cli'
|
|
|
|
|
%:
|
2022-09-11 16:43:29 +00:00
|
|
|
$(GO_RUN_BUILD) $(GFLAGS) $* $(FLAGS)
|
2022-05-02 03:02:05 +00:00
|
|
|
|
2022-05-09 00:49:08 +00:00
|
|
|
.PHONY: docs
|
|
|
|
|
docs:
|
|
|
|
|
mkdocs build
|
|
|
|
|
|
|
|
|
|
.PHONY: serve-docs
|
|
|
|
|
serve-docs:
|
|
|
|
|
mkdocs serve
|
