add flag to ignore all external directories per project

[motatoes]

This will introduce a parameter called triggerProjectsFromDirOnly which if set will cause generation to not have include_patterns outside of the project directories itself:

Usage:

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

it will cause generated projects to only be reflected from the directory itself, for example if the expected include_patterns would be:

"staging/aws/us-east-1/k8s/.hcl", "staging/terragrunt-root.hcl vpc/.tf*", "staging/aws/us-east-1/aws_region.tfvars", "staging/aws/aws_assume_role_arn.tfvars", "staging/aws/us-east-1/k8s/.tf"

and the project directory is staging/aws/us-east-1/k8s then only these paths will be considered:

"staging/aws/us-east-1/k8s/.hcl", "staging/aws/us-east-1/k8s/.tf*"

---

---

Summary by CodeRabbit

• New Features

  • Introduced a new configuration option to filter project paths based on a directory flag, enhancing project update triggers.
  • Added a function to filter patterns based on a specified project path for more precise file handling.

• Bug Fixes

  • Improved error handling for pattern normalization during configuration loading.

• Tests

  • Added tests for the new path filtering function to ensure correct functionality.

[coderabbitai]

Walkthrough

The changes in this pull request introduce enhancements to the digger_config package. A new boolean field, TriggerProjectsFromDirOnly, is added to the TerragruntParsingConfig structure to refine project path handling. A new function, FilterPathsOutsideOfProjectPath, is introduced to filter file paths based on the specified project path. Additionally, a corresponding test function, TestFilterPathsOutsideOfProjectPath, is created to validate this new functionality. The overall structure and existing methods remain unchanged, ensuring that the enhancements integrate smoothly into the existing codebase.

Changes

File Path	Change Summary
libs/digger_config/digger_config.go	Added conditional check in hydrateDiggerConfigYamlWithTerragrunt to filter WhenModified patterns based on TriggerProjectsFromDirOnly. Retained error handling.
libs/digger_config/utils.go	Added new function FilterPathsOutsideOfProjectPath to filter patterns based on projectPath. Updated imports to include strings.
libs/digger_config/utils_test.go	Introduced test function TestFilterPathsOutsideOfProjectPath to validate the filtering logic of the new function.
libs/digger_config/yaml.go	Added new field TriggerProjectsFromDirOnly to TerragruntParsingConfig for YAML serialization.

Poem

In the garden where paths intertwine,
A new flag blooms, oh how divine!
Filtering paths with care and grace,
In the project’s heart, they find their place.
With tests to ensure all's well and bright,
The config grows, a joyful sight! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1366848 and 4a1c45b.

📒 Files selected for processing (1)

• libs/digger_config/utils.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• libs/digger_config/utils.go

---

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.

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (3)

libs/digger_config/yaml.go (1)

147-147: Add documentation and consider field placement

The new TriggerProjectsFromDirOnly field needs documentation to explain its purpose and impact. Consider grouping it with related fields for better organization.

+	// TriggerProjectsFromDirOnly when enabled, only considers file changes within
+	// the project directory for triggering updates. Changes to files outside the
+	// project directory are ignored.
 	TriggerProjectsFromDirOnly bool     `yaml:"triggerProjectsFromDirOnly"`

libs/digger_config/digger_config.go (2)

565-569: Improve error handling for path filtering

The error handling for FilterPathsOutsideOfProjectPath could be more specific to help with debugging.

 if parsingConfig.TriggerProjectsFromDirOnly {
-    atlantisProject.Autoplan.WhenModified, err = FilterPathsOutsideOfProjectPath(projectDir, atlantisProject.Autoplan.WhenModified)
+    filteredPaths, err := FilterPathsOutsideOfProjectPath(projectDir, atlantisProject.Autoplan.WhenModified)
+    if err != nil {
+        return fmt.Errorf("failed to filter paths for project %s: %v", atlantisProject.Name, err)
+    }
+    atlantisProject.Autoplan.WhenModified = filteredPaths
 }

---

565-569: Add code comments to explain the path filtering behavior

The path filtering logic would benefit from documentation explaining when and why paths are filtered.

+    // Filter out paths that are outside of the project directory when TriggerProjectsFromDirOnly is enabled.
+    // This ensures that changes to external directories don't trigger unnecessary project updates.
     if parsingConfig.TriggerProjectsFromDirOnly {
         atlantisProject.Autoplan.WhenModified, err = FilterPathsOutsideOfProjectPath(projectDir, atlantisProject.Autoplan.WhenModified)
     }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c9a0625 and 1366848.

📒 Files selected for processing (4)

• libs/digger_config/digger_config.go (1 hunks)
• libs/digger_config/utils.go (2 hunks)
• libs/digger_config/utils_test.go (1 hunks)
• libs/digger_config/yaml.go (1 hunks)

🔇 Additional comments (1)

libs/digger_config/yaml.go (1)

147-147: Verify impact on existing projects

The introduction of TriggerProjectsFromDirOnly could change behavior for existing projects that rely on external file triggers. Please ensure this is documented in release notes and migration guides.