Skip to content

Commit

Permalink
docs: Add known limitations (#582)
Browse files Browse the repository at this point in the history
Co-authored-by: George L. Yermulnik <yz@yz.kiev.ua>
  • Loading branch information
MaxymVlasov and yermulnik committed Nov 1, 2023
1 parent 7122298 commit 95fc56f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Expand Up @@ -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)
Expand Down Expand Up @@ -285,6 +286,10 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo

## Hooks usage notes and examples

### Known limitations

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).

### All hooks: Usage of environment variables in `--args`

> All, except deprecated hooks: `checkov`, `terraform_docs_replace`
Expand Down

0 comments on commit 95fc56f

Please sign in to comment.