Build
Makefile — the patterns that work for small projects
Makefile patterns for small projects: targets and .PHONY, variables, a self-documenting help target, pattern rules and tab gotchas.
Basic target
build:
\tgo build -o bin/app ./cmd/appTargets indented with TAB (not spaces). Hard rule.
.PHONY (target is not a file)
.PHONY: build test cleanAlways declare task targets as PHONY or Make may skip them.
Variables
BINARY := bin/app
SRC := $(wildcard cmd/**/*.go)
build: $(BINARY)
$(BINARY): $(SRC)
\tgo build -o $@ ./cmd/appHelp target (showing all available)
.PHONY: help
help: ## Show this help
\t@grep -E '^[a-zA-Z_-]+:.*?## ' $(MAKEFILE_LIST) | awk -F':.*?## ' '{printf " %-20s %s\n", $$1, $$2}'
build: ## Compile the app
\tgo build -o bin/app
test: ## Run tests
\tgo test ./...Run make help and see all targets with descriptions.
Conditional + env
ENV ?= dev
deploy:
ifeq ($(ENV),prod)
\t@echo "Deploying to prod"
else
\t@echo "Deploying to dev"
endifPattern rule
%.html: %.md
\tpandoc $< -o $@make report.html runs pandoc on report.md.
Common gotcha
- Each line of a recipe runs in its own subshell.
cd dirthenmake-thingin next line doesn't carry the dir. Chain with&&or use.ONESHELL:. - Variables:
=is lazy/recursive,:=is immediate. Use:=unless you specifically want recursion.