Makefile Recipes for Real Projects

.PHONY: help
help: ## Show available targets
  @grep -E '^[a-zA-Z0-9_.-]+:.*?## ' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%-24s %s
", $$1, $$2}'

# List available targets and descriptions.

.PHONY: bootstrap
bootstrap: ## Install local dependencies
  pnpm install
  pre-commit install

# Install development dependencies and prepare local state.

.PHONY: all
all: lint test build

# Aggregate common build steps.

.PHONY: lint test build
lint:
  pnpm lint

test:
  pnpm test

build:
  pnpm build

# Lint, test, and build JavaScript or TypeScript projects.

.PHONY: fmt lint test
fmt:
  ruff format .

lint:
  ruff check .

test:
  pytest -q

# Format, lint, and test a Python project.

.PHONY: fmt test build
fmt:
  go fmt ./...

test:
  go test ./...

build:
  go build ./...

# Format, test, and build Go projects.

build:
  ./gradlew build

test:
  ./gradlew test

# Wrap build tool commands in stable team-facing targets.

IMAGE ?= example/app
TAG ?= latest

.PHONY: docker-build
docker-build:
  docker build -t $(IMAGE):$(TAG) .

# Build a container image with a version tag.

docker-push:
  docker push $(IMAGE):$(TAG)

# Push a previously built image.

ENV ?= dev

terraform-plan:
  cd infra/$(ENV) && terraform init && terraform plan -out=tfplan

# Run a named plan file for a chosen environment.

terraform-apply:
  cd infra/$(ENV) && terraform apply tfplan

# Apply the previously generated plan.

deploy-web:
  aws s3 sync dist/ s3://$(WEB_BUCKET) --delete
  aws cloudfront create-invalidation --distribution-id $(DIST_ID) --paths '/*'

# Sync built files to a bucket and invalidate a CDN.

version.txt:
  @printf '%s
' '$(VERSION)' > $@

# Write current version metadata into an artifact.

tag-release:
  git tag v$(VERSION)
  git push origin v$(VERSION)

# Tag the current commit with a release version.

changelog:
  git log --oneline --decorate $$(git describe --tags --abbrev=0)..HEAD

# Capture commit history since the last tag.