suport ignore include blocks for terragrunt

[motatoes]

supporting a special flag in generate projects which would ignore includes during terragrunt project generation:

generate_projects:
  terragrunt_parsing:
    parallel: true
    createProjectName: true
    createWorkspace: true
    defaultWorkflow: default
    ignoreIncludeBlocks: true

The flag ignoreIncludeBlocks being true will cause any terragrunt include blocks to not be included

include {
  path = find_in_parent_folders("terragrunt.hcl")
}

Summary by CodeRabbit

• New Features

  • Introduced a new parameter, IgnoreIncludeBlocks, allowing users to control the parsing behavior of include blocks in Terragrunt configurations.
  • Enhanced dependency management by enabling users to specify whether to include dependencies from included blocks during project creation.

• Bug Fixes

  • Improved error handling related to the new parameter in the parsing process.

• Documentation

  • Updated configuration options for parsing Terragrunt files to include the new IgnoreIncludeBlocks field.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request enhance the handling of include blocks in Terragrunt configurations. A new parameter, IgnoreIncludeBlocks, is added to multiple functions within the atlantis package, affecting the parsing and project creation processes. Additionally, a corresponding field is introduced in the TerragruntParsingConfig struct, allowing users to specify whether to ignore include blocks during parsing. These modifications improve the flexibility of dependency management and configuration parsing without altering the existing control flow or functionality.

Changes

File Path	Change Summary
libs/digger_config/digger_config.go	Added parameter IgnoreIncludeBlocks to atlantis.Parse function call in hydrateDiggerConfigYamlWithTerragrunt. Updated error handling to include the new parameter.
libs/digger_config/terragrunt/atlantis/generate.go	Added ignoreIncludeBlocks parameter to getDependencies, createProject, createHclProject, and Parse functions. Updated logic to skip included dependencies based on this flag.
libs/digger_config/yaml.go	Added field IgnoreIncludeBlocks (pointer to boolean) in TerragruntParsingConfig struct for YAML serialization.

Sequence Diagram(s)

Loading

sequenceDiagram
    participant User
    participant Atlantis
    participant Terragrunt

    User->>Atlantis: Request to parse configuration
    Atlantis->>Terragrunt: Call Parse(gitRoot, projectHclFiles, ignoreIncludeBlocks)
    alt ignoreIncludeBlocks is true
        Terragrunt->>Terragrunt: Skip included dependencies
    else ignoreIncludeBlocks is false
        Terragrunt->>Terragrunt: Include all dependencies
    end
    Terragrunt->>Atlantis: Return parsed configuration
    Atlantis->>User: Provide parsed configuration

🐰 "In the land of code where rabbits play,
A new flag hops in to brighten the day.
Ignore those blocks, let dependencies flow,
With IgnoreIncludeBlocks, watch the magic grow!
Parsing made easy, oh what a delight,
In Terragrunt's world, everything feels right!" 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1d8067a and c684144.

📒 Files selected for processing (3)

• libs/digger_config/digger_config.go (1 hunks)
• libs/digger_config/terragrunt/atlantis/generate.go (10 hunks)
• libs/digger_config/yaml.go (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • 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 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.