From 889d83a810ffc78e9ec21652cc8843cfe89d6837 Mon Sep 17 00:00:00 2001 From: Anton Babenko Date: Mon, 27 May 2019 09:32:47 -0700 Subject: [PATCH] Added note about incompatibility of terraform-docs with Terraform 0.12 --- .pre-commit-config.yaml | 2 +- README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1c444a95a..f80cfc805 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: git://github.com/pre-commit/pre-commit-hooks - rev: v2.0.0 + rev: v2.2.3 hooks: - id: check-yaml - id: end-of-file-fixer diff --git a/README.md b/README.md index 08749368b..fac045ae5 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,10 @@ Step into the repository you want to have the pre-commit hooks installed and run ```bash cat < .pre-commit-config.yaml - repo: git://github.com/antonbabenko/pre-commit-terraform - rev: v1.11.0 + rev: v1.12.0 hooks: - id: terraform_fmt - - id: terraform_docs + # - id: terraform_docs # terraform-docs is not working with Terraform 0.12 yet (read note in README) EOF ``` @@ -73,6 +73,8 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo 1. It is possible to pass additional arguments to shell scripts when using `terraform_docs` and `terraform_docs_without_aggregate_type_defaults`. Send pull-request with the new hook if there is something missing. +1. `terraform-docs` is not working with Terraform 0.12 yet (see [issue #62](https://github.com/segmentio/terraform-docs/issues/62)), so remember to disable `terraform_docs`, `terraform_docs_replace` and `terraform_docs_without_aggregate_type_defaults` hooks in your `.pre-commit-config.yaml` + ## Notes for developers 1. Python hooks are supported now too. All you have to do is: