You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -343,10 +343,14 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo
343
343
344
344
### Docker-based hooks (no local tool installation required)
345
345
346
-
For users who prefer not to install tools locally, Docker-based versions are available for most hooks. These hooks use a Docker image with all tools pre-installed and provide the same functionality as their script-based counterparts.
347
-
Note: These hooks are defined with pre-commit `language: docker_image` and reference the Docker image via the `entry` field in `.pre-commit-hooks.yaml`.
348
-
These hooks run inside the tools image defined by the hook itself (no image configuration needed in your `.pre-commit-config.yaml`). The image is published at `ghcr.io/antonbabenko/pre-commit-terraform-tools` and can be pinned by tag (e.g., `entry: ghcr.io/antonbabenko/pre-commit-terraform-tools:latest`) or by digest (e.g., `entry: ghcr.io/antonbabenko/pre-commit-terraform-tools@sha256:...`).
349
-
Tip: `ghcr.io/antonbabenko/pre-commit-terraform` is the container image for running pre-commit itself, whereas `...-tools` is the image used by the Docker-based hooks.
346
+
For users who prefer not to install tools locally, Docker-based versions are
347
+
available for most hooks. These hooks use a Docker image with all tools
348
+
pre-installed and provide the same functionality as their script-based
349
+
counterparts.
350
+
351
+
> [!NOTE]
352
+
> These hooks run inside the Docker image defined by the hook itself. By default, it set to
353
+
`entry: ghcr.io/antonbabenko/pre-commit-terraform:latest` which is **NOT WHAT WE WANT**. Better to figure out how to pin it # TODO
@@ -359,9 +363,6 @@ Tip: `ghcr.io/antonbabenko/pre-commit-terraform` is the container image for runn
359
363
|`terraform_trivy_docker`|`terraform_trivy`| Security analysis with Trivy using Docker |
360
364
|`infracost_breakdown_docker`|`infracost_breakdown`| Infrastructure cost analysis using Docker |
361
365
362
-
> **Note:**
363
-
> By default, `terraform_docs_docker` is configured with `pass_filenames: false` and an explicit `.` target. This documents only the root module, which is the most common use case. If you want to generate documentation for multiple modules in a monorepo, you can customize the `args` in your own `.pre-commit-config.yaml` (for example, add `--recursive` to the arguments).
0 commit comments