makefile

Author: marcincuber

AGENTS.md

@@ -53,6 +53,12 @@ terraform validate
 terraform test
 ```
 
+You can also run the local aggregate target:
+
+```bash
+make check
+```
+
 For example changes, also run the same init and validate commands from the touched example directory.
 
 Do not run `terraform apply`, `terraform destroy`, or destructive state commands unless the user explicitly asks for them and confirms the target environment.

Makefile

@@ -0,0 +1,61 @@
+SHELL := /bin/bash
+
+EXAMPLES := $(wildcard examples/*)
+
+.PHONY: help fmt fmt-check docs docs-check init validate test examples-init examples-validate check hooks
+
+help:
+	@echo "Available targets:"
+	@echo "  make fmt                Format all Terraform files"
+	@echo "  make fmt-check          Check Terraform formatting"
+	@echo "  make docs               Generate README Terraform docs"
+	@echo "  make docs-check         Check README Terraform docs are current"
+	@echo "  make init               Initialize the root module"
+	@echo "  make validate           Validate the root module"
+	@echo "  make test               Run native Terraform tests"
+	@echo "  make examples-init      Initialize all examples"
+	@echo "  make examples-validate  Validate all examples"
+	@echo "  make check              Run local CI-style checks"
+	@echo "  make hooks              Enable repo-local Git hooks"
+
+fmt:
+	terraform fmt -recursive
+
+fmt-check:
+	terraform fmt -check -recursive
+
+docs:
+	scripts/terraform-docs.sh
+
+docs-check:
+	scripts/terraform-docs.sh --check
+
+init:
+	terraform init -backend=false
+
+validate:
+	terraform validate
+
+test:
+	terraform test -no-color
+
+examples-init:
+	@for example in $(EXAMPLES); do \
+		if [ -d "$$example" ]; then \
+			echo "Initializing $$example"; \
+			terraform -chdir="$$example" init -backend=false; \
+		fi; \
+	done
+
+examples-validate:
+	@for example in $(EXAMPLES); do \
+		if [ -d "$$example" ]; then \
+			echo "Validating $$example"; \
+			terraform -chdir="$$example" validate; \
+		fi; \
+	done
+
+check: fmt-check docs-check init validate test examples-init examples-validate
+
+hooks:
+	git config core.hooksPath .githooks

README.md

@@ -142,6 +142,16 @@ terraform test
 
 Pull requests run the same tests through `.github/workflows/terraform-pr.yml`, along with formatting, generated-docs, validation, and example checks.
 
+## Local Development
+
+Use the Makefile for common local checks:
+
+```bash
+make fmt
+make docs
+make check
+```
+
 ## Notes
 
 - The module does not create VPC, subnet, route table, NAT gateway, or security baseline resources.