Skip to content

Conversation

@habakke
Copy link
Collaborator

@habakke habakke commented Oct 6, 2025

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.md for 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:

  • Major rewrite of README.md to 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:

  • Added _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:

  • Refactored auth-gcp-action/action.yml to 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.
  • Created a new auth-github-action/action.yml with input validation and clear documentation for authenticating to GitHub Container Registry, replacing the previous implementation.

Security and reliability updates:

  • Removed legacy composite action definitions for authentication and Docker security scanning (.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:

  • Improved the release workflow in .github/workflows/release.yml by 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

@habakke habakke requested a review from Copilot October 6, 2025 07:56
@habakke habakke self-assigned this Oct 6, 2025
@habakke habakke added the change It's a change! label Oct 6, 2025
Copy link

Copilot AI left a 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.js module 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.

@habakke habakke force-pushed the habakke/enhance-actions branch from c9c0587 to 4c20b86 Compare October 6, 2025 12:18
@habakke habakke requested a review from saetremyr October 6, 2025 12:18
@habakke habakke requested a review from saetremyr October 6, 2025 13:54
@habakke habakke changed the title Habakke/enhance actions Improvements and refactoring of shared actions Oct 7, 2025
@habakke habakke merged commit 59edcea into master Oct 7, 2025
@habakke habakke deleted the habakke/enhance-actions branch October 7, 2025 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

change It's a change!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants