Add output_dir to inputs in multiple sections

[therealgglggl]

The following was omitted starting at the dependency examples : output_dir = get_terragrunt_dir()
This was causing an error when running "terragrunt run --all plan" : │ Error: No value for required variable
│
│ on main.tf line 5:
│ 5: variable "output_dir" {}
│
│ The root module input variable "output_dir" is not set, and has no default
│ value. Use a -var or -var-file command line argument to provide a value for
│ this variable.

Description

Fixes #000.

TODOs

Read the Gruntwork contribution guidelines.

• I authored this code entirely myself
• I am submitting code based on open source software (e.g. MIT, MPL-2.0, Apache)]
• I am adding or upgrading a dependency or adapted code and confirm it has a compatible open source license
• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added / Removed / Updated [X].

Migration Guide

Summary by CodeRabbit

• Documentation
  • Updated quick-start guide to document configuration for directing generated files to unit directories instead of the Terragrunt cache directory, improving file organization and accessibility.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

@therealgglggl is attempting to deploy a commit to the Gruntwork Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

📝 Walkthrough

Walkthrough

Added output_dir = get_terragrunt_dir() to three input blocks in the quick-start documentation, enabling generated files to be written directly to unit directories instead of the Terragrunt cache directory.

Changes

Cohort / File(s)	Summary
Documentation Update docs-starlight/src/content/docs/01-getting-started/01-quick-start.mdx	Added output_dir = get_terragrunt_dir() to three input blocks to configure output file destination

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Fix getting started docs #4516 — Also modifies getting-started docs to add output_dir = get_terragrunt_dir() to example inputs blocks in Terragrunt tutorial
• Update 01-quick-start.mdx #4883 — Introduces and wires output_dir configuration via get_terragrunt_dir() to ensure generated files are written to unit directories
• Update QuickStart documentation with an additional example to control the output directory #4299 — Modifies the same quick-start documentation file to add output_dir parameter for directing generated files to unit directories

Suggested reviewers

• denis256
• yhakbar

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description explains the issue and changes, but most required template sections are incomplete or placeholder content, with no release notes or migration guide details.	Complete the description with a proper issue number, fill in the 'Added/Removed/Updated' section in Release Notes, and specify if there are backward incompatible changes requiring a migration guide.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding output_dir to inputs in multiple sections, directly matching the summary and objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs-starlight/src/content/docs/01-getting-started/01-quick-start.mdx (1)

341-351: Consider showing both foo and bar examples explicitly.

While the text at line 339 correctly states "Then in your foo/terragrunt.hcl and bar/terragrunt.hcl files...", only one example is provided. For maximum clarity, consider showing both files explicitly since they both need the output_dir input after the module update:

💡 Optional clarity improvement

 Then in your `foo/terragrunt.hcl` and `bar/terragrunt.hcl` files, you can use the `get_terragrunt_dir()` built-in function to get the directory where the `terragrunt.hcl` file is located:

+```hcl
+# foo/terragrunt.hcl
+terraform {
+  source = "../shared"
+}
+
+inputs = {
+  output_dir = get_terragrunt_dir()
+  content = "Hello from foo, Terragrunt!"
+}
+```
+
 ```hcl
+# bar/terragrunt.hcl
 terraform {
   source = "../shared"
 }

 inputs = {
   output_dir = get_terragrunt_dir()
   content = "Hello from bar, Terragrunt!"
 }

This would help users following the tutorial understand that both files need updating, though the current version is functionally correct based on the guidance at line 57 referencing the complete examples repository.

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between e0a2f684b6814f730732b104e98e245fb0ebf1ae and 137690edc51c87506ce05efc0b9fe02eab8bdbe3.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs-starlight/src/content/docs/01-getting-started/01-quick-start.mdx`

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (1)</summary>

<details>
<summary>docs-starlight/**/*.md*</summary>


**⚙️ CodeRabbit configuration file**

> Review the documentation for clarity, grammar, and spelling. Make sure that the documentation is easy to understand and follow. There is currently a migration underway from the Jekyll based documentation in `docs` to the Starlight + Astro based documentation in `docs-starlight`. Make sure that the `docs-starlight` documentation is accurate and up-to-date with the `docs` documentation, and that any difference between them results in an improvement in the `docs-starlight` documentation.

Files:
- `docs-starlight/src/content/docs/01-getting-started/01-quick-start.mdx`

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (3)</summary><blockquote>

<details>
<summary>docs-starlight/src/content/docs/01-getting-started/01-quick-start.mdx (3)</summary><blockquote>

`377-390`: **LGTM! Essential addition to the dependency example.**

The `output_dir` parameter is correctly added to the inputs block, which is necessary after the shared module was updated in Step 5 to require this variable. This ensures the example works when users follow the tutorial.

---

`438-454`: **LGTM! Consistent addition in mock_outputs example.**

The `output_dir` parameter is properly included in this variation of the bar/terragrunt.hcl configuration, maintaining consistency with the previous dependency example.

---

`515-533`: **LGTM! Final consistent addition completes the pattern.**

The `output_dir` parameter is correctly included in this final variation, ensuring all bar/terragrunt.hcl examples throughout the tutorial are complete and functional after the module update.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->