Skip to content

Conversation

@ZachGoldberg
Copy link
Contributor

@ZachGoldberg ZachGoldberg commented Oct 23, 2025

Summary by CodeRabbit

  • Documentation
    • Updated documentation to reflect support for Terragrunt versions 0.86.3 through 1.0+
    • Clarified HCL as the default configuration format and YML deprecation timeline
    • Removed outdated version support information

@vercel
Copy link

vercel bot commented Oct 23, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Building Building Preview Comment Oct 23, 2025 6:11pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2025

Walkthrough

Documentation update to the Terragrunt upgrade guide: added sections detailing support for newer Terragrunt versions through 1.0 and promoting HCL as the default configuration format while deprecating YML. Removed outdated version compatibility information.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/2.0/docs/pipelines/previous-versions/upgrading-github-v3-to-v4.md
Added two new sections: "Support for newer Terragrunt Versions (through to 1.0)" covering Terragrunt 0.86.3 through 1.0+, and "Updated Configuration: Deprecating YML and promoting HCL out of beta" detailing HCL promotion and YML deprecation plan. Removed outdated duplicate Terragrunt version support section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

The changes are limited to a single documentation file with straightforward content additions and removals. Review effort focuses on validating the accuracy of version information and deprecation messaging.

Poem

🚀 Terragrunt grows with each passing season,
From v3 to v4, there's reason to reason,
HCL takes the crown, YML fades away,
Clearer paths forward for the upgrade day! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "add HCL promotion to whats new" is clearly related to the main changes in this pull request. The summary confirms that a key addition is a new section titled "Updated Configuration: Deprecating YML and promoting HCL out of beta," which directly aligns with what the title describes. The title is specific and concise, clearly communicating the primary change—promoting HCL—without unnecessary noise or vague language. The developer's choice of branch name "hcl-promotion-doc" further corroborates that HCL promotion is the intended focus of this changeset.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch hcl-promotion-doc

Comment @coderabbitai help to get the list of available commands and usage tips.

@Resonance1584 Resonance1584 changed the title add HCL promotion tow hats new add HCL promotion to whats new Oct 23, 2025
@ZachGoldberg ZachGoldberg merged commit f0ab50d into main Oct 23, 2025
5 of 7 checks passed
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/2.0/docs/pipelines/previous-versions/upgrading-github-v3-to-v4.md (1)

8-9: Minor clarity: Standardize version range wording between heading and body.

Line 8 uses "through to 1.0" but line 9 says "through to 1.0+". For consistency and clarity, align these. Consider using standard phrasing like "through 1.0+" or "1.0 and later" in both places.

-### Support for newer Terragrunt Versions (through to 1.0)
-Pipelines previously had maximum Terragrunt version of 0.84.  This version of Pipelines removes this restriction and will support all Terragrunt versions from `0.86.3` through to 1.0+.
+### Support for newer Terragrunt Versions (through 1.0 and later)
+Pipelines previously had maximum Terragrunt version of 0.84. This version of Pipelines removes this restriction and will support all Terragrunt versions from `0.86.3` through 1.0 and later.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63a17a0 and 9baec6e.

📒 Files selected for processing (1)
  • docs/2.0/docs/pipelines/previous-versions/upgrading-github-v3-to-v4.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Pull Request has non-contributor approval
  • GitHub Check: Pull Request has non-contributor approval
  • GitHub Check: Validate generated content
  • GitHub Check: validate_build
🔇 Additional comments (1)
docs/2.0/docs/pipelines/previous-versions/upgrading-github-v3-to-v4.md (1)

11-12: Content looks good and integrates well with the migration guide.

This section clearly communicates the HCL promotion and YML deprecation, which aligns nicely with the "Replace YML Config with HCL Config" section (line 104+). The messaging is consistent and sets up the migration path well for readers.

If you haven't already, ensure the "full feature parity" claim is documented or linked elsewhere in your docs so readers can verify this is comprehensive. A link to the API reference or feature comparison would strengthen this.

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