-
Notifications
You must be signed in to change notification settings - Fork 1
[PRM-392] Updated workflow names #414
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
Co-authored-by: Copilot <[email protected]>
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 PR standardizes workflow names across GitHub Actions files to improve organization and consistency. The changes implement a new naming convention that categorizes workflows with prefixes like "Deploy:", "Tool:", "Z-AUTOMATED", and "Z-BASE" for better visibility and grouping in the GitHub interface.
Key changes:
- Adopts a consistent naming convention with category prefixes
- Removes two unused workflows (terraform-deploy-virus-scanner.yml and terraform-deploy-to-perf-manual.yml)
- Standardizes deployment workflow names with "Deploy:" prefix
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/tool-rename-git-tag.yml | Updates name to use "Tool:" prefix |
| .github/workflows/terraform-deploy-virus-scanner.yml | Removes entire unused workflow file |
| .github/workflows/terraform-deploy-to-perf-manual.yml | Removes entire unused workflow file |
| .github/workflows/tear-down-sandbox.yml | Updates name to "Tear down: Sandbox" format |
| .github/workflows/deploy-test.yml | Simplifies name to "Deploy: Test" |
| .github/workflows/deploy-sandbox.yml | Simplifies name to "Deploy: Sandbox" |
| .github/workflows/deploy-prod.yml | Simplifies name to "Deploy: Prod" |
| .github/workflows/deploy-pre-prod.yml | Updates name to "Deploy: Pre-prod" |
| .github/workflows/base-cleanup-lambda-edge.yml | Updates name to use "Z-BASE:" prefix |
| .github/workflows/base-cleanup-appconfig-and-lambda-layer-versions.yml | Updates name to use "Z-BASE:" prefix |
| .github/workflows/automated-tear-down-test.yml | Updates name to use "Z-AUTOMATED" prefix |
| .github/workflows/automated-tear-down-sandbox.yml | Updates name to use "Z-AUTOMATED" prefix |
| .github/workflows/automated-sonarqube-cloud.yml | Updates name to use "Z-AUTOMATED:" prefix |
| .github/workflows/automated-deploy-dev.yml | Updates name to use "Z-AUTOMATED" prefix |
| .github/workflows/automated-daily-health-check.yml | Updates name to use "Z-AUTOMATED:" prefix |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -1,4 +1,4 @@ | |||
| name: 'Remove Lambda@Edge Associations' | |||
| name: 'Z-BASE: Cleanup (Lambda@Edge)' | |||
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.
What does the Z-base and Z-automated stand for?
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.
AUTOMATED- These workflows run by themselves (not triggered manually)BASE- These workflows cannot be run directly, i.e. they can only be triggered within other workflows - they would never show any runs associated with them (https://github.com/orgs/community/discussions/12025#discussioncomment-10773117)- The
Zprefix just places these workflows at the bottom of the UI, as the GitHub UI lists the workflows in order, leaving the manually available workflows at the top.
| @@ -1,4 +1,4 @@ | |||
| name: 'Cleanup Untracked App Config Profiles and Lambda Layer Versions' | |||
| name: 'Z-BASE: Cleanup (App Config Profiles & Lambda Layer Versions)' | |||
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.
Maybe a more generic name so that this can be used for other cleanup if needed in the future.
"Z-BASE: Workspace Cleanup" ?
| @@ -1,4 +1,4 @@ | |||
| name: 'Remove Lambda@Edge Associations' | |||
| name: 'Z-BASE: Cleanup (Lambda@Edge)' | |||
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.
Could be "Z-BASE: Lambda Edge Cleanup"
| @@ -1,5 +1,5 @@ | |||
| # .github/workflows/terraform-dev | |||
| name: 'Development CI Feature to Main' | |||
| name: 'Z-AUTOMATED Deploy: Dev' | |||
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.
Should there be something in between Z-Automated and Deploy
"Z-AUTOMATED: Deploy - Dev" ?
.github/workflows/deploy-prod.yml
Outdated
| @@ -1,5 +1,5 @@ | |||
| # .github/workflows/terraform-dev | |||
| name: "Deploy tagged version to Prod" | |||
| name: "Deploy: Prod" | |||
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.
Should these include Z-BASE or maybe another identifier?
i.e. "Z-BASE: Deploy - Prod"
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.
Maybe "Z-MANUAL" ?
I'm not really sure what the Z stands for.
Report for environment: ndr-devTerraform Initialization ⚙️
|
No description provided.