Skip to content

Commit 1108a8f

Browse files
committed
chore: More coderabbit nitpicks
1 parent 246cbe5 commit 1108a8f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,9 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo
344344
### Docker-based hooks (no local tool installation required)
345345

346346
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 parameter 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 with a tag or digest pinned in .pre-commit-hooks.yaml.
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.
349350

350351

351352
| Docker Hook ID | Equivalent Script Hook | Description |
@@ -372,8 +373,8 @@ These hooks run inside the tools image defined by the hook itself (no image conf
372373
**Requirements and limitations:**
373374

374375
* Docker must be installed and accessible.
375-
* For pre-commit.ci: its agents do not have Docker; skip these hooks for now.
376-
* Note: pre-commit supports Docker hooks; pre-commit.ci may add Docker support in the future.
376+
* pre-commit.ci runners do not support Docker; skip these hooks there for now.
377+
* Note: pre-commit (the framework) supports Docker hooks; pre-commit.ci may add Docker support in the future.
377378
* You can still use Docker-based hooks in CI/CD (e.g., GitHub Actions, GitLab CI) by running `pre-commit run --all-files` (or `pre-commit run -a`) on runners where Docker is available. This enforces the same checks in CI as locally, even if pre-commit.ci doesn’t support Docker yet.
378379

379380
**Skipping Docker hooks on pre-commit.ci:**

0 commit comments

Comments
 (0)