From 95fc56f84c6c0d2363c47dfec6c6e931d26e9f36 Mon Sep 17 00:00:00 2001 From: Maksym Vlasov Date: Wed, 1 Nov 2023 17:05:24 +0200 Subject: [PATCH] docs: Add known limitations (#582) Co-authored-by: George L. Yermulnik --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 04a67055f..4f0eee1d4 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 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`