fix: Fixing CLI option for --queue-include-unit-reading

[yhakbar]

Description

We renamed this flag, but didn't update the docs for it.

TODOs

Read the Gruntwork contribution guidelines.

• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Updated queue-include-units-reading in cli-options.

Summary by CodeRabbit

• Documentation
  • Updated CLI options documentation to reflect new naming conventions.
  • Renamed a primary command-line argument and adjusted its alias.
  • Marked the previous environment variable alias as deprecated for a smoother transition.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terragrunt-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 10, 2025 10:52pm

[coderabbitai]

Walkthrough

The documentation for Terragrunt CLI options has been updated to reflect a renaming change. The CLI argument --terragrunt-queue-include-units-reading is now documented as --queue-include-units-reading, and the corresponding environment variable alias has been adjusted and marked as deprecated. These changes ensure consistency in the naming convention and provide guidance for users transitioning to the updated option.

Changes

File(s)	Change Summary
docs/_docs/.../02-cli-options.md	Updated the documentation to rename the CLI argument from --terragrunt-queue-include-units-reading to --queue-include-units-reading and marked the previous environment variable alias as deprecated.

Suggested reviewers

• denis256
• Resonance1584
• levkohimins

Poem

In the docs, a fresh breeze began to flow,
CLI options realigned, now on with the show.
Old names whisper farewell in a gentle tone,
While new flags step up to take the throne.
Cheers for clarity that helps our code glow!
🚀📚
A little change, a big step in our workflow!

---

📜 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 a958298 and e5a8343.

📒 Files selected for processing (1)

• docs/_docs/04_reference/02-cli-options.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/_docs/04_reference/02-cli-options.md

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: unessential
• GitHub Check: build-and-test

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.