-
Notifications
You must be signed in to change notification settings - Fork 0
Improvements and refactoring of shared actions #41
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request enhances the shared GitHub Actions repository by consolidating actions from .github/actions/ to root-level directories, improving documentation with a comprehensive README, and adding a shared JavaScript module for Terraform PR comments. The changes focus on better organization, input validation, and code reuse across actions.
- Moved composite actions from
.github/actions/to root directories for better organization - Added comprehensive README with usage examples and prerequisites
- Created shared
terraform-pr-comment.jsmodule to eliminate code duplication between GCP and OpenStack Terraform actions
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| terraform-deploy-openstack-action/action.yml | Updated to use shared PR comment module and improved input validation |
| terraform-deploy-gcp-action/action.yml | Updated to use shared PR comment module and improved input validation |
| release-action/action.yml | Enhanced with input validation and better parameter handling |
| examples/*.yml | Updated to reference new action paths and improved configuration |
| docker-security-scan-action/action.yml | New consolidated action with input validation |
| docker-build-action/action.yml | Enhanced with input validation and conditional GCP setup |
| auth-github-action/action.yml | New consolidated GitHub authentication action |
| auth-gcp-action/action.yml | Enhanced with workload identity support and input validation |
| _shared/terraform-pr-comment.js | New shared module for Terraform PR comments with enhanced features |
| _shared/README.md | Documentation for shared modules |
| README.md | Comprehensive rewrite with usage examples and prerequisites |
| .github/workflows/release.yml | Updated to use new action path and added job summary |
| .github/actions/docker-security-scan/action.yml | Removed legacy action |
| .github/actions/auth-github/action.yml | Removed legacy action |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…ared module and enhance platform support
Co-authored-by: Copilot <[email protected]>
c9c0587 to
4c20b86
Compare
Description
This pull request introduces several improvements and refactorings to the shared GitHub Actions repository, focusing on documentation, reliability, and maintainability of composite actions for CI/CD workflows. The most significant changes include a major rewrite of the
README.mdfor clarity and onboarding, the addition of a shared JavaScript module for posting Terraform plan results to PR comments, and updates to authentication actions for better input validation and support for modern best practices.Documentation and onboarding improvements:
README.mdto provide a comprehensive overview of available actions, usage examples, onboarding instructions, and prerequisites, making it easier for new users to understand and adopt the repository.Terraform workflow enhancements:
_shared/terraform-pr-comment.js, a shared module to reliably post Terraform plan results to PR comments, featuring smart updates, size management, security/destroy warnings, and platform-specific branding. This module is designed for reuse across GCP and OpenStack actions, reducing code duplication. [1] [2]Authentication action improvements:
auth-gcp-action/action.ymlto validate inputs and support both service account key and workload identity federation, updating dependencies to use the latest versions of Google authentication and setup actions.auth-github-action/action.ymlwith input validation and clear documentation for authenticating to GitHub Container Registry, replacing the previous implementation.Security and reliability updates:
.github/actions/auth-github/action.yml,.github/actions/docker-security-scan/action.yml) to reduce duplication and enforce use of updated, validated actions. [1] [2]Release workflow refinements:
.github/workflows/release.ymlby clarifying input descriptions, updating action references, and adding a job summary step for better visibility of release metadata. [1] [2]Change management
See project labels for change classification and risk.
Change reason?
Please describe the reason for the change here.
Change rollback plan?
If nothing else is specified, the change will be rolled back by reverting the commit.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
list any relevant details for your test configuration