Skip to content

Commit 95fc56f

Browse files
docs: Add known limitations (#582)
Co-authored-by: George L. Yermulnik <[email protected]>
1 parent 7122298 commit 95fc56f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ If you are using `pre-commit-terraform` already or want to support its developme
3636
* [4. Run](#4-run)
3737
* [Available Hooks](#available-hooks)
3838
* [Hooks usage notes and examples](#hooks-usage-notes-and-examples)
39+
* [Known limitations](#known-limitations)
3940
* [All hooks: Usage of environment variables in `--args`](#all-hooks-usage-of-environment-variables-in---args)
4041
* [All hooks: Set env vars inside hook at runtime](#all-hooks-set-env-vars-inside-hook-at-runtime)
4142
* [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
285286

286287
## Hooks usage notes and examples
287288

289+
### Known limitations
290+
291+
Terraform operates on a per-dir basis, while `pre-commit` framework only supports files and files that exist. This means if you only remove the TF-related file without any other changes in the same dir, checks will be skipped. Example and details [here](https://github.com/pre-commit/pre-commit/issues/3048).
292+
288293
### All hooks: Usage of environment variables in `--args`
289294

290295
> All, except deprecated hooks: `checkov`, `terraform_docs_replace`

0 commit comments

Comments
 (0)