Added note about incompatibility of terraform-docs with Terraform 0.12 (

#41)
antonbabenko · May 27, 2019 · 5725b11 · 5725b11
1 parent 418a5ec
commit 5725b11
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git 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
@@ -21,10 +21,10 @@ Step into the repository you want to have the pre-commit hooks installed and run
 ```bash
 cat <<EOF > .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: