pre-commit-terraform/examples/.pre-commit-config-docker.yaml at b3e14c8ea8f39abeea958e9e29c198b9c80d9f41 · actuarysailor/pre-commit-terraform · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Example .pre-commit-config.yaml for using Docker-based hooks
# This configuration uses Docker containers instead of requiring local tool installation

# Skip Docker hooks on pre-commit.ci (which doesn't support Docker)
ci:
  skip:
  - terraform_fmt_docker
  - terraform_validate_docker
  - terraform_tflint_docker
  - terraform_docs_docker
  - terraform_checkov_docker
  - terraform_trivy_docker
  - infracost_breakdown_docker

repos:
- repo: https://github.com/actuarysailor/pre-commit-terraform
  rev: v1.96.1  # Use a stable release version
  hooks:
  # Option 1: Use Docker-based hooks (no local tool installation required)
  # These require the pre-commit-terraform-tools Docker image
  - id: terraform_fmt_docker
  - id: terraform_validate_docker
  - id: terraform_docs_docker
  - id: terraform_checkov_docker
  - id: terraform_trivy_docker
  - id: terraform_tflint_docker
  - id: infracost_breakdown_docker  # Requires INFRACOST_API_KEY

  # Option 2: Use traditional script-based hooks (requires local tools)
  # Uncomment these if you have terraform, tflint, etc. installed locally
  # - id: terraform_fmt
  # - id: terraform_validate
  # - id: terraform_docs
  # - id: terraform_tflint
  # - id: terraform_checkov

# You can also mix both approaches:
# Use Docker hooks for tools you don't have installed locally,
# and script hooks for tools you do have locally

# Docker hooks advantages:
# ✅ No need to install tools locally (terraform, tflint, checkov, etc.)
# ✅ Consistent tool versions across team members
# ✅ Isolated environment prevents dependency conflicts
# ✅ Works on any system with Docker installed

# Docker hooks considerations:
# ⚠️  Requires Docker to be installed and accessible
# ⚠️  Slightly slower due to container startup overhead
# ⚠️  May require proper Docker permissions setup
# ⚠️  Need to ensure Docker image is available (pull or build)

# Build the tools image locally with:
# docker build -f Dockerfile.tools -t ghcr.io/actuarysailor/pre-commit-terraform-tools:latest .

# Or use the pre-built image once published:
# docker pull ghcr.io/actuarysailor/pre-commit-terraform-tools:latest