Update terragrunt command and comment.

Change Summary

This git diff modifies the plan.yml workflow file within the .github/workflows directory. Specifically, it updates the Terragrunt action command and its parameters, enhancing logging and comment functionalities.

Technical Details

• File Modified: .github/workflows/plan.yml
• Changes:
  • Updated the tg_command parameter to include --log-level stdout and --log-format bare, improving logging clarity and detail.
  • Changed tg_comment from true to 1, which likely activates a different commenting behavior or level within the GitHub Actions workflow.

Key Learnings & Insights

• Enhanced Logging: The addition of --log-level stdout and --log-format bare provides more granular and readable logs. This is crucial for debugging and monitoring the Terragrunt plan execution.
• Comment Activation: Switching tg_comment from true to 1 suggests a more sophisticated or configurable commenting system, possibly allowing for better integration with GitHub’s issue tracking or pull request discussions.
• Configuration Best Practices: These changes reflect a best practice in CI/CD pipelines—ensuring that logs are detailed yet manageable and that comments are effectively utilized for collaboration.

Impact Assessment

• Performance: There should be no significant performance impact, as these changes primarily affect logging and commenting rather than computational processes.
• Security: Enhanced logging can aid in security audits by providing clearer trails of execution. However, ensure sensitive information is not logged.
• Maintainability: Improved logging and commenting will make the workflow easier to maintain and debug, enhancing overall team collaboration.

Developer Notes

• Gotchas: Ensure that the new logging level does not expose sensitive information. Review the Terragrunt documentation to understand the full implications of --log-level stdout and --log-format bare.
• Future Improvements: Consider adding conditional logging based on the environment (e.g., more verbose logs in development vs. production).
• Context for New Developers: These changes were made to improve the visibility and collaboration within the CI/CD pipeline. Familiarize yourself with Terragrunt’s logging and commenting features to leverage these improvements fully.