Enhanced workflow automation for deployment.

Change Summary

This git diff outlines modifications to the GitHub Actions workflows for deploying and planning Infrastructure as Code (IaC). The changes include updates to the trigger conditions and the steps involved in the workflows.

Technical Details

• deploy.yml
  • Trigger Condition: Added specific paths (IaC/** and .github/workflows/deploy.yml) to the on.push.paths to ensure the workflow runs only when changes are made to these directories.
  • Step Change: Renamed the step from Install Terragrunt and OpenTofu to Terragrunt Apply and adjusted the action to directly apply the Terragrunt configuration.
• plan.yml
  • Trigger Condition: Added specific paths (IaC/** and .github/workflows/plan.yml) to the on.pull_request.paths to ensure the workflow runs only when changes are made to these directories.
  • Step Change: Renamed the step from Install Terragrunt and OpenTofu to Terragrunt Plan and adjusted the action to directly plan the Terragrunt configuration.

Key Learnings & Insights

• Trigger Optimization: By specifying paths in the trigger conditions, the workflows are more efficient, running only when relevant files are changed. This reduces unnecessary executions and conserves CI/CD resources.
• Action Clarity: Renaming steps to Terragrunt Apply and Terragrunt Plan provides clearer intent and improves readability of the workflow files.
• Direct Actions: Directly applying or planning the Terragrunt configuration within the specified steps streamlines the process, making the workflows more straightforward and maintainable.

Impact Assessment

• Efficiency: The workflows will now run less frequently, only when changes are made to the IaC directories or the workflow files themselves. This reduces the load on the CI/CD pipeline.
• Clarity: The renamed steps make it easier for developers to understand the purpose of each step in the workflow, enhancing maintainability.
• Resource Usage: By optimizing when the workflows run, there is a potential reduction in resource usage, leading to cost savings in the CI/CD environment.

Developer Notes

• Path-Specific Triggers: Ensure that any future changes to the IaC or workflow files are correctly handled by these triggers. Avoid making unrelated changes in these directories to prevent unintended workflow executions.
• Step Naming Conventions: Continue to use clear and descriptive names for workflow steps to maintain readability and understandability.
• Future Improvements: Consider adding additional checks or conditions to further refine when these workflows should run, potentially integrating with other parts of the CI/CD pipeline for a more holistic approach.