misc(Makefile): add help
target to display the help msg
This commit is contained in:
parent
9befe0dd51
commit
b5251c6ac4
1 changed files with 30 additions and 23 deletions
53
Makefile
53
Makefile
|
@ -22,40 +22,41 @@ LINT_EXECUTABLES = misspell shellcheck
|
||||||
DOCKER_BUILD_PLATFORMS ?= linux/amd64,linux/arm64
|
DOCKER_BUILD_PLATFORMS ?= linux/amd64,linux/arm64
|
||||||
|
|
||||||
.PHONY: default
|
.PHONY: default
|
||||||
|
#? default: Run `make generate` and `make binary`
|
||||||
default: generate binary
|
default: generate binary
|
||||||
|
|
||||||
## Create the "dist" directory
|
#? dist: Create the "dist" directory
|
||||||
dist:
|
dist:
|
||||||
mkdir -p dist
|
mkdir -p dist
|
||||||
|
|
||||||
## Build WebUI Docker image
|
|
||||||
.PHONY: build-webui-image
|
.PHONY: build-webui-image
|
||||||
|
#? build-webui-image: Build WebUI Docker image
|
||||||
build-webui-image:
|
build-webui-image:
|
||||||
docker build -t traefik-webui -f webui/Dockerfile webui
|
docker build -t traefik-webui -f webui/Dockerfile webui
|
||||||
|
|
||||||
## Clean WebUI static generated assets
|
|
||||||
.PHONY: clean-webui
|
.PHONY: clean-webui
|
||||||
|
#? clean-webui: Clean WebUI static generated assets
|
||||||
clean-webui:
|
clean-webui:
|
||||||
rm -r webui/static
|
rm -r webui/static
|
||||||
mkdir -p webui/static
|
mkdir -p webui/static
|
||||||
printf 'For more information see `webui/readme.md`' > webui/static/DONT-EDIT-FILES-IN-THIS-DIRECTORY.md
|
printf 'For more information see `webui/readme.md`' > webui/static/DONT-EDIT-FILES-IN-THIS-DIRECTORY.md
|
||||||
|
|
||||||
## Generate WebUI
|
|
||||||
webui/static/index.html:
|
webui/static/index.html:
|
||||||
$(MAKE) build-webui-image
|
$(MAKE) build-webui-image
|
||||||
docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' traefik-webui npm run build:nc
|
docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' traefik-webui npm run build:nc
|
||||||
docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' traefik-webui chown -R $(shell id -u):$(shell id -g) ./static
|
docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' traefik-webui chown -R $(shell id -u):$(shell id -g) ./static
|
||||||
|
|
||||||
.PHONY: generate-webui
|
.PHONY: generate-webui
|
||||||
|
#? generate-webui: Generate WebUI
|
||||||
generate-webui: webui/static/index.html
|
generate-webui: webui/static/index.html
|
||||||
|
|
||||||
## Generate code
|
|
||||||
.PHONY: generate
|
.PHONY: generate
|
||||||
|
#? generate: Generate code (Dynamic and Static configuration documentation reference files)
|
||||||
generate:
|
generate:
|
||||||
go generate
|
go generate
|
||||||
|
|
||||||
## Build the binary
|
|
||||||
.PHONY: binary
|
.PHONY: binary
|
||||||
|
#? binary: Build the binary
|
||||||
binary: generate-webui dist
|
binary: generate-webui dist
|
||||||
@echo SHA: $(VERSION) $(CODENAME) $(DATE)
|
@echo SHA: $(VERSION) $(CODENAME) $(DATE)
|
||||||
CGO_ENABLED=0 GOGC=off GOOS=${GOOS} GOARCH=${GOARCH} go build ${FLAGS[*]} -ldflags "-s -w \
|
CGO_ENABLED=0 GOGC=off GOOS=${GOOS} GOARCH=${GOARCH} go build ${FLAGS[*]} -ldflags "-s -w \
|
||||||
|
@ -80,27 +81,27 @@ binary-windows-amd64: export BIN_NAME := traefik.exe
|
||||||
binary-windows-amd64:
|
binary-windows-amd64:
|
||||||
@$(MAKE) binary
|
@$(MAKE) binary
|
||||||
|
|
||||||
## Build the binary for the standard platforms (linux, darwin, windows)
|
|
||||||
.PHONY: crossbinary-default
|
.PHONY: crossbinary-default
|
||||||
|
#? crossbinary-default: Build the binary for the standard platforms (linux, darwin, windows)
|
||||||
crossbinary-default: generate generate-webui
|
crossbinary-default: generate generate-webui
|
||||||
$(CURDIR)/script/crossbinary-default.sh
|
$(CURDIR)/script/crossbinary-default.sh
|
||||||
|
|
||||||
## Run the unit and integration tests
|
|
||||||
.PHONY: test
|
.PHONY: test
|
||||||
|
#? test: Run the unit and integration tests
|
||||||
test: test-unit test-integration
|
test: test-unit test-integration
|
||||||
|
|
||||||
## Run the unit tests
|
|
||||||
.PHONY: test-unit
|
.PHONY: test-unit
|
||||||
|
#? test-unit: Run the unit tests
|
||||||
test-unit:
|
test-unit:
|
||||||
GOOS=$(GOOS) GOARCH=$(GOARCH) go test -cover "-coverprofile=cover.out" -v $(TESTFLAGS) ./pkg/... ./cmd/...
|
GOOS=$(GOOS) GOARCH=$(GOARCH) go test -cover "-coverprofile=cover.out" -v $(TESTFLAGS) ./pkg/... ./cmd/...
|
||||||
|
|
||||||
## Run the integration tests
|
|
||||||
.PHONY: test-integration
|
.PHONY: test-integration
|
||||||
|
#? test-integration: Run the integration tests
|
||||||
test-integration: binary
|
test-integration: binary
|
||||||
GOOS=$(GOOS) GOARCH=$(GOARCH) go test ./integration -test.timeout=20m -failfast -v $(TESTFLAGS)
|
GOOS=$(GOOS) GOARCH=$(GOARCH) go test ./integration -test.timeout=20m -failfast -v $(TESTFLAGS)
|
||||||
|
|
||||||
## Pull all Docker images to avoid timeout during integration tests
|
|
||||||
.PHONY: pull-images
|
.PHONY: pull-images
|
||||||
|
#? pull-images: Pull all Docker images to avoid timeout during integration tests
|
||||||
pull-images:
|
pull-images:
|
||||||
grep --no-filename -E '^\s+image:' ./integration/resources/compose/*.yml \
|
grep --no-filename -E '^\s+image:' ./integration/resources/compose/*.yml \
|
||||||
| awk '{print $$2}' \
|
| awk '{print $$2}' \
|
||||||
|
@ -108,21 +109,21 @@ pull-images:
|
||||||
| uniq \
|
| uniq \
|
||||||
| xargs -P 6 -n 1 docker pull
|
| xargs -P 6 -n 1 docker pull
|
||||||
|
|
||||||
## Lint run golangci-lint
|
|
||||||
.PHONY: lint
|
.PHONY: lint
|
||||||
|
#? lint: Run golangci-lint
|
||||||
lint:
|
lint:
|
||||||
golangci-lint run
|
golangci-lint run
|
||||||
|
|
||||||
## Validate code and docs
|
|
||||||
.PHONY: validate-files
|
.PHONY: validate-files
|
||||||
|
#? validate-files: Validate code and docs
|
||||||
validate-files: lint
|
validate-files: lint
|
||||||
$(foreach exec,$(LINT_EXECUTABLES),\
|
$(foreach exec,$(LINT_EXECUTABLES),\
|
||||||
$(if $(shell which $(exec)),,$(error "No $(exec) in PATH")))
|
$(if $(shell which $(exec)),,$(error "No $(exec) in PATH")))
|
||||||
$(CURDIR)/script/validate-misspell.sh
|
$(CURDIR)/script/validate-misspell.sh
|
||||||
$(CURDIR)/script/validate-shell-script.sh
|
$(CURDIR)/script/validate-shell-script.sh
|
||||||
|
|
||||||
## Validate code, docs, and vendor
|
|
||||||
.PHONY: validate
|
.PHONY: validate
|
||||||
|
#? validate: Validate code, docs, and vendor
|
||||||
validate: lint
|
validate: lint
|
||||||
$(foreach exec,$(EXECUTABLES),\
|
$(foreach exec,$(EXECUTABLES),\
|
||||||
$(if $(shell which $(exec)),,$(error "No $(exec) in PATH")))
|
$(if $(shell which $(exec)),,$(error "No $(exec) in PATH")))
|
||||||
|
@ -136,51 +137,57 @@ multi-arch-image-%: binary-linux-amd64 binary-linux-arm64
|
||||||
docker buildx build $(DOCKER_BUILDX_ARGS) -t traefik/traefik:$* --platform=$(DOCKER_BUILD_PLATFORMS) -f Dockerfile .
|
docker buildx build $(DOCKER_BUILDX_ARGS) -t traefik/traefik:$* --platform=$(DOCKER_BUILD_PLATFORMS) -f Dockerfile .
|
||||||
|
|
||||||
|
|
||||||
## Clean up static directory and build a Docker Traefik image
|
|
||||||
.PHONY: build-image
|
.PHONY: build-image
|
||||||
|
#? build-image: Clean up static directory and build a Docker Traefik image
|
||||||
build-image: export DOCKER_BUILDX_ARGS := --load
|
build-image: export DOCKER_BUILDX_ARGS := --load
|
||||||
build-image: export DOCKER_BUILD_PLATFORMS := linux/$(GOARCH)
|
build-image: export DOCKER_BUILD_PLATFORMS := linux/$(GOARCH)
|
||||||
build-image: clean-webui
|
build-image: clean-webui
|
||||||
@$(MAKE) multi-arch-image-latest
|
@$(MAKE) multi-arch-image-latest
|
||||||
|
|
||||||
## Build a Docker Traefik image without re-building the webui when it's already built
|
|
||||||
.PHONY: build-image-dirty
|
.PHONY: build-image-dirty
|
||||||
|
#? build-image-dirty: Build a Docker Traefik image without re-building the webui when it's already built
|
||||||
build-image-dirty: export DOCKER_BUILDX_ARGS := --load
|
build-image-dirty: export DOCKER_BUILDX_ARGS := --load
|
||||||
build-image-dirty: export DOCKER_BUILD_PLATFORMS := linux/$(GOARCH)
|
build-image-dirty: export DOCKER_BUILD_PLATFORMS := linux/$(GOARCH)
|
||||||
build-image-dirty:
|
build-image-dirty:
|
||||||
@$(MAKE) multi-arch-image-latest
|
@$(MAKE) multi-arch-image-latest
|
||||||
|
|
||||||
## Build documentation site
|
|
||||||
.PHONY: docs
|
.PHONY: docs
|
||||||
|
#? docs: Build documentation site
|
||||||
docs:
|
docs:
|
||||||
make -C ./docs docs
|
make -C ./docs docs
|
||||||
|
|
||||||
## Serve the documentation site locally
|
|
||||||
.PHONY: docs-serve
|
.PHONY: docs-serve
|
||||||
|
#? docs-serve: Serve the documentation site locally
|
||||||
docs-serve:
|
docs-serve:
|
||||||
make -C ./docs docs-serve
|
make -C ./docs docs-serve
|
||||||
|
|
||||||
## Pull image for doc building
|
|
||||||
.PHONY: docs-pull-images
|
.PHONY: docs-pull-images
|
||||||
|
#? docs-pull-images: Pull image for doc building
|
||||||
docs-pull-images:
|
docs-pull-images:
|
||||||
make -C ./docs docs-pull-images
|
make -C ./docs docs-pull-images
|
||||||
|
|
||||||
## Generate CRD clientset and CRD manifests
|
|
||||||
.PHONY: generate-crd
|
.PHONY: generate-crd
|
||||||
|
#? generate-crd: Generate CRD clientset and CRD manifests
|
||||||
generate-crd:
|
generate-crd:
|
||||||
@$(CURDIR)/script/code-gen-docker.sh
|
@$(CURDIR)/script/code-gen-docker.sh
|
||||||
|
|
||||||
## Generate code from dynamic configuration https://github.com/traefik/genconf
|
|
||||||
.PHONY: generate-genconf
|
.PHONY: generate-genconf
|
||||||
|
#? generate-genconf: Generate code from dynamic configuration github.com/traefik/genconf
|
||||||
generate-genconf:
|
generate-genconf:
|
||||||
go run ./cmd/internal/gen/
|
go run ./cmd/internal/gen/
|
||||||
|
|
||||||
## Create packages for the release
|
|
||||||
.PHONY: release-packages
|
.PHONY: release-packages
|
||||||
|
#? release-packages: Create packages for the release
|
||||||
release-packages: generate-webui
|
release-packages: generate-webui
|
||||||
$(CURDIR)/script/release-packages.sh
|
$(CURDIR)/script/release-packages.sh
|
||||||
|
|
||||||
## Format the Code
|
|
||||||
.PHONY: fmt
|
.PHONY: fmt
|
||||||
|
#? fmt: Format the Code
|
||||||
fmt:
|
fmt:
|
||||||
gofmt -s -l -w $(SRCS)
|
gofmt -s -l -w $(SRCS)
|
||||||
|
|
||||||
|
.PHONY: help
|
||||||
|
#? help: Get more info on make commands
|
||||||
|
help: Makefile
|
||||||
|
@echo " Choose a command run in traefik:"
|
||||||
|
@sed -n 's/^#?//p' $< | column -t -s ':' | sort | sed -e 's/^/ /'
|
||||||
|
|
Loading…
Reference in a new issue