Skip to content

Conversation

@yhakbar
Copy link
Contributor

@yhakbar yhakbar commented Nov 5, 2025

Terragrunt Scale customers don't have access to the service-catalog repository unless they are also library customers.

This uses the new simple S3 bucket module we added to the TGS repository to ensure that anybody can run the tutorial.

Summary by CodeRabbit

  • Documentation
    • Updated deployment tutorials for both standard AWS and AWS Gov Cloud environments with improved S3 bucket configuration examples and clearer instructions
    • Revised and clarified guidance for customizing and ensuring unique S3 bucket names in your infrastructure code
    • Enhanced best practices documentation for bucket naming conventions across different cloud deployment environments

@vercel
Copy link

vercel bot commented Nov 5, 2025

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

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Nov 5, 2025 8:46pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 5, 2025

Walkthrough

Documentation updates to two tutorial files that standardize Terragrunt S3 module configurations by switching the module source from terraform-aws-service-catalog to terragrunt-scale-catalog and updating input parameters accordingly.

Changes

Cohort / File(s) Summary
S3 Terragrunt Module Updates
docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.mdx, docs/2.0/docs/pipelines/tutorials/deploying-your-first-infrastructure-change.mdx
Module source changed from gruntwork-io/terraform-aws-service-catalog to terragrunt-scale-catalog (v1.3.0); input key primary_bucket renamed to name; guidance text updated to clarify S3 bucket name customization.
Azure Documentation Cleanup
docs/2.0/docs/pipelines/tutorials/deploying-your-first-infrastructure-change.mdx
Removed header comment blocks from Azure Resource Group and Storage Account Terragrunt configuration snippets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Straightforward configuration updates applied consistently across both files
  • Module reference and parameter name changes are mechanical and predictable
  • Minor comment removals (formatting cleanup) require minimal scrutiny

Possibly related PRs

Suggested labels

v4

Suggested reviewers

  • oredavids

Poem

📚 From catalogs old to new ones we shift,
S3 buckets get a configuration gift,
Primary becomes name, clean and bright,
Documentation flows with Terragrunt might! ✨

Pre-merge checks and finishing touches

✅ 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 accurately summarizes the main change: switching the Terragrunt configuration from the Terraform AWS Service Catalog to the TGS (terragrunt-scale-catalog) across tutorial documentation files.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/switching-to-terragrunt-scale-catalog-for-tutorial

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a50ba72 and 1cca6f0.

📒 Files selected for processing (2)
  • docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.mdx (2 hunks)
  • docs/2.0/docs/pipelines/tutorials/deploying-your-first-infrastructure-change.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.mdx

📄 CodeRabbit inference engine (.cursor/rules/gitlab-background.mdc)

Whenever presenting information that diverges between GitHub and GitLab, use the and components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full .

Files:

  • docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.mdx
  • docs/2.0/docs/pipelines/tutorials/deploying-your-first-infrastructure-change.mdx
⏰ 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). (2)
  • GitHub Check: Validate generated content
  • GitHub Check: validate_build
🔇 Additional comments (2)
docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.mdx (1)

150-171: Consistent module and parameter updates with helpful documentation clarification.

Line 151 nicely adds explicit guidance about bucket name uniqueness, and the S3 module configuration (lines 160–171) mirrors the updates in the first tutorial file. The consistency across both tutorials is good practice and reduces confusion for users following either path.

The module source and input parameter changes are aligned with the parallel tutorial, which suggests these are intentional, coordinated updates across the documentation.

docs/2.0/docs/pipelines/tutorials/deploying-your-first-infrastructure-change.mdx (1)

64-76: All verified—the module URL and name input parameter are correctly configured.

The terragrunt-scale-catalog S3 module at v1.3.0 properly exports the name input variable as a required string parameter. The module code uses var.name to configure the S3 bucket, and the README confirms this is the correct input for the bucket name. Your documentation code is aligned with the module's API, and the GitHub URL format is standard and correct.


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

@yhakbar yhakbar marked this pull request as ready for review November 5, 2025 20:44
@yhakbar yhakbar merged commit ca9b324 into main Nov 7, 2025
7 checks passed
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.

3 participants