Skip to content

docs: List every hook that requires terragrunt - #1036

Merged
MaxymVlasov merged 1 commit into
antonbabenko:masterfrom
rawsun007:docs-terragrunt-requirement
Nov 10, 2026
Merged

MaxymVlasov merged 1 commit into
antonbabenko:masterfrom
rawsun007:docs-terragrunt-requirement

Conversation

@rawsun007

Copy link
Copy Markdown
Contributor

Put an x into the box if that apply:

  • This PR introduces breaking change.
  • This PR fixes a bug.
  • This PR adds new functionality.
  • This PR enhances existing functionality.

Description of your changes

The requirements list says terragrunt is needed for terragrunt_validate and terragrunt_valid_inputs. There is no terragrunt_valid_inputs hook (it is terragrunt_validate_inputs), and terragrunt_fmt and terragrunt_providers_lock also need terragrunt, as the hooks table already says. This lists all four.

This PR was written by Claude Code (Claude Opus 5.5) from my account; I read the diff before it was opened.

How can we test changes

README only. The four hook ids match .pre-commit-hooks.yaml.

The requirements list named terragrunt_valid_inputs, which is not a
hook, and left out terragrunt_fmt and terragrunt_providers_lock. The
hooks table already lists terragrunt for all four.

Assisted-by: Claude:claude-opus-5-5
@coderabbitai

coderabbitai Bot commented Nov 8, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Updated the documented Terragrunt requirements to cover all four related hooks.

The README updates the hook names listed for the terragrunt dependency.

Changes: Terragrunt dependency documentation

Layer / File(s) Summary
Update Terragrunt hook list
README.md
The dependency entry now lists terragrunt_fmt, terragrunt_validate_inputs, and terragrunt_providers_lock. It replaces the previous hook names, including the misspelled terragrunt_valid_inputs.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: Minimal · up to 6ec2a

The documentation clarifies which hooks require Terragrunt without changing runtime behavior. No merge-blocking risk is identified.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title "docs: List every hook that requires terragrunt" matches the single change in the changeset. The README dependency list now names all four hooks that require terragrunt (terragrunt_fmt, terr…
Description check Passed The description explains the change. It states that the requirements list named a nonexistent hook id (terragrunt_valid_inputs) and omitted terragrunt_fmt and terragrunt_providers_lock. It also notes …
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs: List every hook that requires terragrunt" matches the single change in the changeset. The README dependency list now names all four hooks that require terragrunt (terragrunt_fmt, terragrunt_validate, terragrunt_validate_inputs, terragrunt_providers_lock), replacing the previous two-hook list. The title is specific and describes the primary change.

Full details: Description check

Explanation

The description explains the change. It states that the requirements list named a nonexistent hook id (terragrunt_valid_inputs) and omitted terragrunt_fmt and terragrunt_providers_lock. It also notes the change is README-only and that the four hook ids match .pre-commit-hooks.yaml. The template checkboxes and the Fixes placeholder are left unfilled, but the description is clearly related to the changeset.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 4c4437d and 6ec2a66.

Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@yermulnik yermulnik left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
@MaxymVlasov For when you have a chance please.

@MaxymVlasov
MaxymVlasov enabled auto-merge (squash) November 10, 2026 11:38
@MaxymVlasov
MaxymVlasov merged commit d5230a6 into antonbabenko:master Nov 10, 2026
44 of 45 checks passed
@antonbabenko

Copy link
Copy Markdown
Owner

This PR is included in version 1.109.5 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants