2017-09-08 11:26:03 +03:00
SRCS = $( shell git ls-files '*.go' | grep -v '^vendor/' )
2016-01-29 22:34:17 +03:00
2024-10-07 10:32:05 +03:00
TAG_NAME := $( shell git describe --abbrev= 0 --tags --exact-match)
2019-03-14 18:22:04 +03:00
SHA := $( shell git rev-parse HEAD)
VERSION_GIT := $( if $( TAG_NAME) ,$( TAG_NAME) ,$( SHA) )
VERSION := $( if $( VERSION) ,$( VERSION) ,$( VERSION_GIT) )
2024-01-17 13:12:05 +03:00
BIN_NAME := traefik
2024-02-14 12:26:07 +03:00
CODENAME ?= cheddar
2024-01-17 13:12:05 +03:00
DATE := $( shell date -u '+%Y-%m-%d_%I:%M:%S%p' )
# Default build target
GOOS := $( shell go env GOOS)
GOARCH := $( shell go env GOARCH)
LINT_EXECUTABLES = misspell shellcheck
DOCKER_BUILD_PLATFORMS ?= linux/amd64,linux/arm64
2022-04-05 18:18:07 +03:00
.PHONY : default
2024-01-24 13:58:05 +03:00
#? default: Run `make generate` and `make binary`
2024-01-17 13:12:05 +03:00
default : generate binary
2015-09-15 22:38:54 +03:00
2024-01-24 13:58:05 +03:00
#? dist: Create the "dist" directory
2022-04-05 18:18:07 +03:00
dist :
mkdir -p dist
.PHONY : build -webui -image
2024-01-24 13:58:05 +03:00
#? build-webui-image: Build WebUI Docker image
2019-03-28 13:42:06 +03:00
build-webui-image :
2022-03-18 13:06:08 +03:00
docker build -t traefik-webui -f webui/Dockerfile webui
2015-10-30 10:55:08 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : clean -webui
2024-01-24 13:58:05 +03:00
#? clean-webui: Clean WebUI static generated assets
2022-02-18 17:44:08 +03:00
clean-webui :
rm -r webui/static
mkdir -p webui/static
2022-05-03 18:58:08 +03:00
printf 'For more information see `webui/readme.md`' > webui/static/DONT-EDIT-FILES-IN-THIS-DIRECTORY.md
2022-02-18 17:44:08 +03:00
2022-03-04 17:28:07 +03:00
webui/static/index.html :
$( MAKE) build-webui-image
2022-04-15 12:56:08 +03:00
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
2022-03-04 17:28:07 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : generate -webui
2024-01-24 13:58:05 +03:00
#? generate-webui: Generate WebUI
2022-03-04 17:28:07 +03:00
generate-webui : webui /static /index .html
2019-03-28 13:42:06 +03:00
2024-01-17 13:12:05 +03:00
.PHONY : generate
2024-01-24 13:58:05 +03:00
#? generate: Generate code (Dynamic and Static configuration documentation reference files)
2024-01-17 13:12:05 +03:00
generate :
go generate
2022-04-05 18:18:07 +03:00
.PHONY : binary
2024-01-24 13:58:05 +03:00
#? binary: Build the binary
2024-01-17 13:12:05 +03:00
binary : generate -webui dist
@echo SHA: $( VERSION) $( CODENAME) $( DATE)
CGO_ENABLED = 0 GOGC = off GOOS = ${ GOOS } GOARCH = ${ GOARCH } go build ${ FLAGS [*] } -ldflags " -s -w \
2024-01-17 13:37:50 +03:00
-X github.com/traefik/traefik/v3/pkg/version.Version= $( VERSION) \
-X github.com/traefik/traefik/v3/pkg/version.Codename= $( CODENAME) \
-X github.com/traefik/traefik/v3/pkg/version.BuildDate= $( DATE) " \
2024-01-17 13:12:05 +03:00
-installsuffix nocgo -o " ./dist/ ${ GOOS } / ${ GOARCH } / $( BIN_NAME) " ./cmd/traefik
binary-linux-arm64 : export GOOS := linux
binary-linux-arm64 : export GOARCH := arm 64
binary-linux-arm64 :
@$( MAKE) binary
binary-linux-amd64 : export GOOS := linux
binary-linux-amd64 : export GOARCH := amd 64
binary-linux-amd64 :
@$( MAKE) binary
binary-windows-amd64 : export GOOS := windows
binary-windows-amd64 : export GOARCH := amd 64
binary-windows-amd64 : export BIN_NAME := traefik .exe
binary-windows-amd64 :
@$( MAKE) binary
2015-09-15 22:38:54 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : crossbinary -default
2024-01-24 13:58:05 +03:00
#? crossbinary-default: Build the binary for the standard platforms (linux, darwin, windows)
2024-01-17 13:12:05 +03:00
crossbinary-default : generate generate -webui
$( CURDIR) /script/crossbinary-default.sh
2017-05-04 10:31:39 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : test
2024-01-24 13:58:05 +03:00
#? test: Run the unit and integration tests
2024-06-07 12:06:05 +03:00
test : test -ui -unit test -unit test -integration
2015-09-15 22:38:54 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : test -unit
2024-01-24 13:58:05 +03:00
#? test-unit: Run the unit tests
2024-01-09 19:00:07 +03:00
test-unit :
2024-01-17 13:12:05 +03:00
GOOS = $( GOOS) GOARCH = $( GOARCH) go test -cover "-coverprofile=cover.out" -v $( TESTFLAGS) ./pkg/... ./cmd/...
2021-11-25 13:10:06 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : test -integration
2024-01-24 13:58:05 +03:00
#? test-integration: Run the integration tests
2024-01-17 13:12:05 +03:00
test-integration : binary
GOOS = $( GOOS) GOARCH = $( GOARCH) go test ./integration -test.timeout= 20m -failfast -v $( TESTFLAGS)
2015-09-15 22:38:54 +03:00
2024-01-22 17:30:05 +03:00
.PHONY : test -gateway -api -conformance
2024-02-08 16:15:45 +03:00
#? test-gateway-api-conformance: Run the conformance tests
2024-04-17 16:22:04 +03:00
test-gateway-api-conformance : build -image -dirty
2024-08-30 18:14:03 +03:00
# In case of a new Minor/Major version, the k8sConformanceTraefikVersion needs to be updated.
2024-09-26 10:12:04 +03:00
GOOS = $( GOOS) GOARCH = $( GOARCH) go test ./integration -v -test.run K8sConformanceSuite -k8sConformance -k8sConformanceTraefikVersion= "v3.2" $( TESTFLAGS)
2024-02-08 16:15:45 +03:00
2024-06-07 12:06:05 +03:00
.PHONY : test -ui -unit
#? test-ui-unit: Run the unit tests for the webui
test-ui-unit :
$( MAKE) build-webui-image
docker run --rm -v " $( PWD) /webui/static " :'/src/webui/static' traefik-webui yarn --cwd webui install
docker run --rm -v " $( PWD) /webui/static " :'/src/webui/static' traefik-webui yarn --cwd webui test:unit:ci
2022-04-05 18:18:07 +03:00
.PHONY : pull -images
2024-01-24 13:58:05 +03:00
#? pull-images: Pull all Docker images to avoid timeout during integration tests
2019-03-28 13:42:06 +03:00
pull-images :
2022-04-05 18:18:07 +03:00
grep --no-filename -E '^\s+image:' ./integration/resources/compose/*.yml \
| awk '{print $$2}' \
| sort \
| uniq \
| xargs -P 6 -n 1 docker pull
2015-09-15 22:38:54 +03:00
2024-01-17 13:12:05 +03:00
.PHONY : lint
2024-01-24 13:58:05 +03:00
#? lint: Run golangci-lint
2024-01-17 13:12:05 +03:00
lint :
golangci-lint run
2024-01-09 19:00:07 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : validate -files
2024-01-24 13:58:05 +03:00
#? validate-files: Validate code and docs
2024-10-23 18:06:04 +03:00
validate-files :
2024-01-17 13:12:05 +03:00
$( foreach exec,$( LINT_EXECUTABLES) ,\
2024-01-09 19:00:07 +03:00
$( if $( shell which $( exec ) ) ,,$( error " No $( exec ) in PATH " ) ) )
2024-10-23 18:06:04 +03:00
$( CURDIR) /script/validate-vendor.sh
2024-01-17 13:12:05 +03:00
$( CURDIR) /script/validate-misspell.sh
$( CURDIR) /script/validate-shell-script.sh
2019-04-01 16:30:07 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : validate
2024-01-24 13:58:05 +03:00
#? validate: Validate code, docs, and vendor
2024-10-23 18:06:04 +03:00
validate : lint validate -files
2024-01-17 13:12:05 +03:00
# Target for building images for multiple architectures.
.PHONY : multi -arch -image -%
multi-arch-image-% : binary -linux -amd 64 binary -linux -arm 64
docker buildx build $( DOCKER_BUILDX_ARGS) -t traefik/traefik:$* --platform= $( DOCKER_BUILD_PLATFORMS) -f Dockerfile .
2015-09-22 12:29:41 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : build -image
2024-01-24 13:58:05 +03:00
#? build-image: Clean up static directory and build a Docker Traefik image
2024-01-17 13:12:05 +03:00
build-image : export DOCKER_BUILDX_ARGS := --load
build-image : export DOCKER_BUILD_PLATFORMS := linux /$( GOARCH )
build-image : clean -webui
@$( MAKE) multi-arch-image-latest
2015-09-15 22:38:54 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : build -image -dirty
2024-01-24 13:58:05 +03:00
#? build-image-dirty: Build a Docker Traefik image without re-building the webui when it's already built
2024-01-17 13:12:05 +03:00
build-image-dirty : export DOCKER_BUILDX_ARGS := --load
build-image-dirty : export DOCKER_BUILD_PLATFORMS := linux /$( GOARCH )
build-image-dirty :
@$( MAKE) multi-arch-image-latest
2022-03-03 17:42:08 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : docs
2024-01-24 13:58:05 +03:00
#? docs: Build documentation site
2019-02-26 16:50:07 +03:00
docs :
make -C ./docs docs
2018-07-12 19:26:03 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : docs -serve
2024-01-24 13:58:05 +03:00
#? docs-serve: Serve the documentation site locally
2019-02-26 16:50:07 +03:00
docs-serve :
make -C ./docs docs-serve
2017-10-11 15:46:03 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : docs -pull -images
2024-01-24 13:58:05 +03:00
#? docs-pull-images: Pull image for doc building
2021-03-16 14:08:04 +03:00
docs-pull-images :
make -C ./docs docs-pull-images
2022-04-05 18:18:07 +03:00
.PHONY : generate -crd
2024-01-24 13:58:05 +03:00
#? generate-crd: Generate CRD clientset and CRD manifests
2019-03-14 17:56:06 +03:00
generate-crd :
2023-11-22 13:28:06 +03:00
@$( CURDIR) /script/code-gen-docker.sh
2019-03-14 17:56:06 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : generate -genconf
2024-01-24 13:58:05 +03:00
#? generate-genconf: Generate code from dynamic configuration github.com/traefik/genconf
2021-05-11 17:14:10 +03:00
generate-genconf :
go run ./cmd/internal/gen/
2022-04-05 18:18:07 +03:00
.PHONY : release -packages
2024-01-24 13:58:05 +03:00
#? release-packages: Create packages for the release
2024-01-09 19:00:07 +03:00
release-packages : generate -webui
2024-01-17 13:12:05 +03:00
$( CURDIR) /script/release-packages.sh
2019-03-28 13:42:06 +03:00
2022-04-05 18:18:07 +03:00
.PHONY : fmt
2024-01-24 13:58:05 +03:00
#? fmt: Format the Code
2019-03-28 13:42:06 +03:00
fmt :
gofmt -s -l -w $( SRCS)
2024-01-24 13:58:05 +03:00
.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/^/ /'