Skip to content

support digger planfile #1977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 13, 2025

Conversation

motatoes
Copy link
Contributor

@motatoes motatoes commented Jun 13, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Ensured that environment variables are correctly set when executing "run" steps, improving reliability when using plan files.

Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

Warning

Rate limit exceeded

@motatoes has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4a30349 and f4c1ab0.

📒 Files selected for processing (1)
  • docs/ce/howto/custom-commands.mdx (1 hunks)

Walkthrough

The update modifies the DiggerExecutor.Plan() method to ensure that, during a "run" step, the RunEnvVars map is properly initialized if nil. It then injects a "DIGGER_PLANFILE" environment variable containing the local plan file path before executing the run command.

Changes

File(s) Change Summary
libs/execution/execution.go Ensures RunEnvVars is initialized and adds "DIGGER_PLANFILE" env var before "run" actions

Poem

In the warren where code does dwell,
A new env var hops in to tell—
"DIGGER_PLANFILE" now takes its place,
Guiding each run with a path to trace.
No nil maps to trip or fall,
Just smooth digging, plans for all!
🐇✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch feat/support-DIGGER_PLANFILE-env-variable-for-runs
  • Post Copyable Unit Tests in Comment

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

Adds support for exposing Terraform plan file paths via DIGGER_PLANFILE environment variable in the execution library, enabling third-party tools to analyze plan outputs.

  • Modified libs/execution/execution.go to inject local plan file path into RunEnvVars during plan stage for custom command steps
  • Enhancement facilitates integration with external tools like security scanners and cost estimators that need plan file access

1 file reviewed, 1 comment
Edit PR Review Bot Settings | Greptile

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 567d04f and 4a30349.

📒 Files selected for processing (1)
  • libs/execution/execution.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build

Comment on lines +288 to 294
// setting additional env vars for run step
if d.RunEnvVars == nil {
d.RunEnvVars = make(map[string]string)
}
slog.Debug("adding plan file path to environment", "DIGGER_PLANFILE", d.PlanPathProvider.LocalPlanFilePath())
d.RunEnvVars["DIGGER_PLANFILE"] = d.PlanPathProvider.LocalPlanFilePath()
_, _, err := d.CommandRunner.Run(d.ProjectPath, step.Shell, commands, d.RunEnvVars)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Propagate DIGGER_PLANFILE to "apply" run steps as well

Great to see the map‐initialisation guard and the debug log.
However, Apply() contains an almost identical "run" block (lines 370-379) that still receives d.RunEnvVars without the injected variable, so any helper scripts executed after terraform apply will not see DIGGER_PLANFILE.

Consider extracting the injection into a small helper and re-using it in both places:

+func (d *DiggerExecutor) injectPlanfileEnv() {
+    if d.RunEnvVars == nil {
+        d.RunEnvVars = make(map[string]string)
+    }
+    if _, exists := d.RunEnvVars["DIGGER_PLANFILE"]; !exists {
+        slog.Debug("adding plan file path to environment", "DIGGER_PLANFILE", d.PlanPathProvider.LocalPlanFilePath())
+        d.RunEnvVars["DIGGER_PLANFILE"] = d.PlanPathProvider.LocalPlanFilePath()
+    }
+}

and then

-// setting additional env vars for run step
-if d.RunEnvVars == nil {
-    d.RunEnvVars = make(map[string]string)
-}
-slog.Debug("adding plan file path to environment", "DIGGER_PLANFILE", d.PlanPathProvider.LocalPlanFilePath())
-d.RunEnvVars["DIGGER_PLANFILE"] = d.PlanPathProvider.LocalPlanFilePath()
+// inject plan file env var
+d.injectPlanfileEnv()

Repeat the same call in Apply() before the CommandRunner.Run.

This keeps behaviour consistent and avoids code duplication.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// setting additional env vars for run step
if d.RunEnvVars == nil {
d.RunEnvVars = make(map[string]string)
}
slog.Debug("adding plan file path to environment", "DIGGER_PLANFILE", d.PlanPathProvider.LocalPlanFilePath())
d.RunEnvVars["DIGGER_PLANFILE"] = d.PlanPathProvider.LocalPlanFilePath()
_, _, err := d.CommandRunner.Run(d.ProjectPath, step.Shell, commands, d.RunEnvVars)
// ----- Add this helper somewhere (e.g. right after the DiggerExecutor type) -----
func (d *DiggerExecutor) injectPlanfileEnv() {
if d.RunEnvVars == nil {
d.RunEnvVars = make(map[string]string)
}
if _, exists := d.RunEnvVars["DIGGER_PLANFILE"]; !exists {
slog.Debug("adding plan file path to environment", "DIGGER_PLANFILE", d.PlanPathProvider.LocalPlanFilePath())
d.RunEnvVars["DIGGER_PLANFILE"] = d.PlanPathProvider.LocalPlanFilePath()
}
}
// ----- In the Run() method (around lines 288–294), replace the inline injection block with -----
// inject plan file env var
d.injectPlanfileEnv()
_, _, err := d.CommandRunner.Run(d.ProjectPath, step.Shell, commands, d.RunEnvVars)
🤖 Prompt for AI Agents
In libs/execution/execution.go around lines 288 to 294, the environment variable
DIGGER_PLANFILE is injected into d.RunEnvVars only in the run step, but the
apply step (lines 370-379) lacks this injection, causing inconsistency. To fix
this, extract the DIGGER_PLANFILE injection logic into a helper function that
initializes d.RunEnvVars if nil and sets the variable, then call this helper
both in the run step and before the CommandRunner.Run call in the apply step to
ensure consistent environment setup and avoid code duplication.

@motatoes motatoes merged commit 3540796 into develop Jun 13, 2025
12 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.

1 participant