github/pre-commit-opentofu
1
0
Fork 1
mirror of https://github.com/tofuutils/pre-commit-opentofu.git synced 2025-10-15 17:38:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

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

Browse source
This commit is contained in:
Anton Babenko 2019-05-27 09:33:32 -07:00 • committed by GitHub
commit 5725b11b55
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.pre-commit-config.yaml
View file

@ -1,6 +1,6 @@
repos: repos:
- repo: git://github.com/pre-commit/pre-commit-hooks - repo: git://github.com/pre-commit/pre-commit-hooks
rev: v2.0.0 rev: v2.2.3
hooks: hooks:
- id: check-yaml - id: check-yaml
- id: end-of-file-fixer - id: end-of-file-fixer

6
README.md
View file

@ -21,10 +21,10 @@ Step into the repository you want to have the pre-commit hooks installed and run
```bash ```bash
cat <<EOF > .pre-commit-config.yaml cat <<EOF > .pre-commit-config.yaml
- repo: git://github.com/antonbabenko/pre-commit-terraform - repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.11.0 rev: v1.12.0
hooks: hooks:
- id: terraform_fmt - id: terraform_fmt
- id: terraform_docs # - id: terraform_docs # terraform-docs is not working with Terraform 0.12 yet (read note in README)
EOF 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. 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 ## Notes for developers
1. Python hooks are supported now too. All you have to do is: 1. Python hooks are supported now too. All you have to do is: