diff --git a/README.md b/README.md index 04a67055f..5079c181b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ If you are using `pre-commit-terraform` already or want to support its developme * [4. Run](#4-run) * [Available Hooks](#available-hooks) * [Hooks usage notes and examples](#hooks-usage-notes-and-examples) + * [Known limitations](#known-limitations) * [All hooks: Usage of environment variables in `--args`](#all-hooks-usage-of-environment-variables-in---args) * [All hooks: Set env vars inside hook at runtime](#all-hooks-set-env-vars-inside-hook-at-runtime) * [All hooks: Disable color output](#all-hooks-disable-color-output) @@ -285,6 +286,10 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo ## Hooks usage notes and examples +### Known limitations + +Terraform operate on per-dir basic, when `pre-commit` only supports files and files that exist. That means if you only remove tf-related file without any other changes in same dir, check will be skipped. Example and details [here](https://github.com/pre-commit/pre-commit/issues/3048) + ### All hooks: Usage of environment variables in `--args` > All, except deprecated hooks: `checkov`, `terraform_docs_replace`