pre-commit hooks to keep Terraform configurations in a good share ;)
fmt
- Rewrites all Terraform configuration files to a canonical format.validate_without_variables
- Validates all Terraform configuration files without checking whether all required variables were set.validate_with_variables
- Validates all Terraform configuration files and checks whether all required variables were specified.docs
- Inserts input and output documentation intoREADME.md
.
-
validate_without_variables
andvalidate_with_variables
will not work if variables are being set dynamically (eg, when using Terragrunt). Useterragrunt validate
command instead. -
docs
will insert/update documentation generated by terraform-docs between markers -<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
and<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
if they are present inREADME.md
. Make sure thatterraform-docs
is installed.
.pre-commit-config.yaml
:
- repo: git://github.com/devops-talks/terraform-git-hook
hooks:
- id: fmt
- id: docs
Enjoy the clean and documented code!