fix(terragrunt_* hooks): Use new subcommands for terragrunt v0.78.0+ instead of deprecated ones

[bai]

The hclfmt command is no longer supported by terragrunt. Use terragrunt hcl format instead.

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

terragrunt_fmt currently runs hclfmt under the hood but that command was changed to terragrunt hcl format a while ago.

hclfmt is being deprecated and terragrunt produces a warning on execution,
See https://github.com/gruntwork-io/terragrunt/releases/tag/v0.78.0

Fix :
WARN The `hclfmt` command is deprecated and will be removed in a future version of Terragrunt. Use `terragrunt hcl format` instead.

With terragrunt v0.78 or above the pre-commit hook terragrunt_fmt should not emit any warnings.

Note: for version v0.77.22 and below hcl format is just ignored, no error but neither format for broken files.

How can we test changes

I applied the PR to pre-commit config locally and it fixed the issue.

[Copilot]

Pull Request Overview

This PR fixes a bug by updating the deprecated command "terragrunt hclfmt" to the correct "terragrunt hcl format" in the pre-commit hook.

• Replaces outdated command calls with the new syntax
• Updates inline comments to reflect the command change

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• New Features
  • Improved compatibility with different Terragrunt versions by automatically selecting the correct subcommands for formatting, validation, and provider locking.
• Bug Fixes
  • Ensured scripts work seamlessly with both older and newer Terragrunt versions, preventing potential errors from CLI changes.
• Chores
  • Updated internal logic for version detection and command selection to enhance maintainability and future-proofing.

Summary by CodeRabbit

• New Features

  • Improved compatibility with multiple Terragrunt versions by automatically selecting the correct command syntax for formatting, validation, input validation, and provider locking operations.

• Bug Fixes

  • Resolved issues that could occur when running scripts with newer or older versions of Terragrunt by dynamically adapting to the installed version.

Walkthrough

A new function was added to dynamically select the appropriate Terragrunt formatting command based on the installed version. Calls to the formatting command and related comments were updated to use this dynamic command instead of a hardcoded one. Additionally, validation and provider lock scripts were updated to use version-dependent subcommands. No control flow or error handling changes were introduced.

Changes

File(s)	Change Summary
hooks/_common.sh	Added common::terragrunt_version_ge_0.78 function to check Terragrunt version for command selection.
hooks/terragrunt_fmt.sh	Modified to use dynamic Terragrunt formatting subcommand based on version; updated calls and comments accordingly.
hooks/terragrunt_validate_inputs.sh	Updated terragrunt validation subcommands to be version-dependent, using new version check function.
hooks/terragrunt_providers_lock.sh	Updated provider lock subcommand to be version-dependent using the version check function.
hooks/terragrunt_validate.sh	Updated validation subcommand for whole-repo runs to be version-dependent using the version check function.

Suggested labels

bug_with_workaround

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 346b177 and 66dc273.

📒 Files selected for processing (4)

• hooks/terragrunt_fmt.sh (3 hunks)
• hooks/terragrunt_providers_lock.sh (2 hunks)
• hooks/terragrunt_validate.sh (2 hunks)
• hooks/terragrunt_validate_inputs.sh (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (4)

• hooks/terragrunt_validate_inputs.sh
• hooks/terragrunt_validate.sh
• hooks/terragrunt_providers_lock.sh
• hooks/terragrunt_fmt.sh

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

Find out that it will not work as expected for older versions of terragrunt. See #900

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

hooks/terragrunt_fmt.sh (1)

98-103: Multi-word command splitting in repo-wide hook
The same issue applies here in run_hook_on_whole_repo. Please split format_cmd into an array before invoking:

 function run_hook_on_whole_repo {
-  local format_cmd
-  format_cmd=$(get_terragrunt_format_cmd)
-  terragrunt "$format_cmd" "$(pwd)" "${args[@]}"
+  read -r -a format_parts <<< "$(get_terragrunt_format_cmd)"
+  terragrunt "${format_parts[@]}" "$(pwd)" "${args[@]}"

These changes mirror the fix in the per-dir hook above.

🧹 Nitpick comments (2)

hooks/terragrunt_fmt.sh (2)

10-37: Review get_terragrunt_format_cmd: version detection is solid, but handle unused patch
The function correctly extracts and compares Terragrunt versions to decide between hclfmt and hcl format.

• Consider renaming the patch variable to _patch or adding a # shellcheck disable=SC2034 to avoid SC2034 (unused variable) warnings.

🧰 Tools

🪛 Shellcheck (0.10.0)

[warning] 29-29: patch appears unused. Verify use (or export if used externally).

(SC2034)

---

44-44: Update the inline comment for dynamic formatting
Line 44 still references the hardcoded terragrunt hcl format command. Since the hook now selects between hclfmt and hcl format, update this comment to reflect that it uses the chosen subcommand.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0735b9e and fa91c5d.

📒 Files selected for processing (1)

• hooks/terragrunt_fmt.sh (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

hooks/terragrunt_fmt.sh (1)

hooks/_common.sh (4)

• common::initialize (31-36)
• common::parse_cmdline (52-115)
• common::export_provided_env_vars (590-608)
• common::parse_and_export_env_vars (123-152)

🪛 Shellcheck (0.10.0)

hooks/terragrunt_fmt.sh

[warning] 29-29: patch appears unused. Verify use (or export if used externally).

(SC2034)

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

hooks/_common.sh (2)

610-620: Fix typos and improve grammar in documentation.

The newly added comment block has a few minor spelling and grammar issues:

• "subcomand" → "subcommand"
• "help to determine" → "helps determine"
• Remove redundant "or not" and normalize spacing around version numbers.

Proposed diff:

-#######################################################################
-# Check if the installed Terragrunt version is >=0.78.0 or not
-#
-# This function help to determine which terragrunt subcomand to use
-# based on Terragrunt version
-#
-# Returns:
-#   - 0 if version >= 0.78.0
-#   - 1 if version < 0.78.0
-#    Defaults to 0 if version cannot be determined
-#######################################################################
+########################################################################
+# Check if the installed Terragrunt version is >= 0.78.0
+##
+## This function helps determine which Terragrunt subcommand to use
+## based on the installed version.
+##
+## Returns:
+##   0 if version >= 0.78.0 (or if version cannot be determined)
+##   1 if version <  0.78.0
+########################################################################

---

625-642: Consider more robust version parsing and comparison.

Currently you extract only major.minor via grep -oE '[0-9]+\.[0-9]+' and rely on Bash’s pipefail exceptions within a command substitution. To make this more resilient and maintainable, you could:

1. Append || true after the grep to guard against any unexpected non-zero exits.
2. Leverage sort -V for semantic version comparison (including patch numbers) instead of manual integer checks.
3. Cache the result of terragrunt --version in a variable if this function is called multiple times in one run.

Example diff:

-  terragrunt_version=$(terragrunt --version 2> /dev/null | grep -oE '[0-9]+\.[0-9]+')
+  terragrunt_version=$(terragrunt --version 2> /dev/null | grep -oE '[0-9]+\.[0-9]+' || echo "")

-  IFS='.' read -r major minor <<< "$terragrunt_version"
-
-  # `hcl format` support added in v0.78.0 (May 2025)
-  if [[ $major -gt 0 ]] || [[ $major -eq 0 && $minor -ge 78 ]]; then
-    return 0
-  else
-    return 1
-  fi
+  # Use sort -V to compare full version semantics (major.minor.patch)
+  if [[ -n "$terragrunt_version" ]] && \
+     [[ $(printf '%s\n' "0.78.0" "$terragrunt_version" | sort -V | head -n1) == "0.78.0" ]]; then
+    return 0
+  elif [[ -z "$terragrunt_version" ]]; then
+    # Default to newer subcommand if version cannot be parsed
+    return 0
+  else
+    return 1
+  fi

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fa91c5d and f04a3ad.

📒 Files selected for processing (2)

• hooks/_common.sh (1 hunks)
• hooks/terragrunt_fmt.sh (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• hooks/terragrunt_fmt.sh

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

hooks/_common.sh (1)

613-613: Typo: fix ‘subcomand’ to ‘subcommand’.

Spelling in the doc comment should be corrected for clarity.

- # This function helps to determine which terragrunt subcomand to use
+ # This function helps to determine which terragrunt subcommand to use

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 127f3f9 and 25f4370.

📒 Files selected for processing (3)

• hooks/_common.sh (1 hunks)
• hooks/terragrunt_fmt.sh (3 hunks)
• hooks/terragrunt_validate_inputs.sh (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• hooks/terragrunt_fmt.sh

🧰 Additional context used

🧬 Code Graph Analysis (1)

hooks/terragrunt_validate_inputs.sh (1)

hooks/_common.sh (1)

• common::terragrunt_version_ge_0.78 (622-640)

🪛 Shellcheck (0.10.0)

hooks/_common.sh

[error] 622-622: Couldn't parse this brace group. Fix to allow more checks.

(SC1073)

---

[error] 629-629: Expected a '}'. If you have one, try a ; or \n in front of it.

(SC1056)

---

[error] 629-629: Unexpected keyword/token. Fix any mentioned problems and try again.

(SC1072)

🔇 Additional comments (3)

hooks/terragrunt_validate_inputs.sh (3)

19-25: Version-based command selection is implemented correctly.

The if common::terragrunt_version_ge_0.78 logic cleanly chooses between the new (hcl validate --inputs / run --all hcl validate --inputs) and legacy (validate-inputs / run-all validate-inputs) subcommands.

---

59-60: Per-directory invocation uses dynamic command.

Invoking terragrunt "${SUBCOMMAND[@]}" "${args[@]}" correctly applies the version-dependent subcommand for individual directories.

---

76-76: Whole-repo invocation uses dynamic command.

Calling terragrunt "${RUN_ALL_SUBCOMMAND[@]}" "${args[@]}" now properly handles both new and deprecated workflows based on installed Terragrunt.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 25f4370 and 0d10a11.

📒 Files selected for processing (2)

• hooks/terragrunt_providers_lock.sh (2 hunks)
• hooks/terragrunt_validate.sh (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

hooks/terragrunt_providers_lock.sh (1)

hooks/_common.sh (1)

• common::terragrunt_version_ge_0.78 (622-640)

hooks/terragrunt_validate.sh (1)

hooks/_common.sh (1)

• common::terragrunt_version_ge_0.78 (622-640)

🔇 Additional comments (2)

hooks/terragrunt_providers_lock.sh (1)

73-73: Approve dynamic invocation of Terragrunt subcommands

Using

terragrunt "${RUN_ALL_SUBCOMMAND[@]}" "${args[@]}"

in run_hook_on_whole_repo correctly delegates to version-specific subcommands and keeps this hook aligned with others.

hooks/terragrunt_validate.sh (1)

73-73: Approve dynamic invocation of Terragrunt subcommands

The change to

terragrunt "${RUN_ALL_SUBCOMMAND[@]}" "${args[@]}"

in run_hook_on_whole_repo cleanly replaces the deprecated hardcoded call and mirrors the same approach in other Terragrunt hooks.

[yermulnik]

Hope I didn't miss anything and didn't add a mess with suggestions =))

[bai]

Thanks @MaxymVlasov ❤️

[MaxymVlasov]

Minor issue with access rights for Release job. Should be fixed soon

[antonbabenko]

This PR is included in version 1.99.1 🎉