README.md

Terraform hook

The hook helps to maintain the quality and consistency of your Terraform code by automatically formatting, validating, and testing it at different stages of the development workflow.

Features

Terraform Docs

We use terraform-docs to generate documentation of Terraform projects. However project must have .terraform-docs.yml configuration file in your root folder of your project.

Pre-commit Hook

The pre-commit hook will run terraform fmt, terraform validate and terraform-docs markdown to ensure your Terraform code is properly formatted, valid and documented before committing.

Pre-push Hook

The pre-push hook will run terraform test to ensure your Terraform code passes all tests before pushing to the remote repository.

Direct Execution

You can also run the Terraform commands directly using Lefthook:

• lefthook run terraform
• lefthook run terraform --commands fmt
• lefthook run terraform --commands validate
• lefthook run terraform --commands test
• lefthook run terraform --commands docs

How to Use It

# .lefthook.yaml
remotes:
  - git_url: git@github.com:boozt-platform/lefthook
    ref: [tag]
    configs:
      # terraform validation, fmt and tests
      - hooks/terraform/.lefthook.yaml

Do extend or override the commands you may do as following:

# .lefthook-local.yaml
extends:
  - hooks/terraform/.lefthook.yaml

# this would override the Terraform default version
terraform:
  commands:
    fmt:
      env:
        TF_VERSION: 1.10.5
    docs:
      env:
        TF_DOCS_VERSION: 0.19.0