VIA-598 AJ Update workflows for readability

Author: ankur-jain-nhs

.github/workflows/cicd-1-pull-request.yaml

@@ -151,7 +151,7 @@ jobs:
       - name: "Checkout code"
         uses: actions/checkout@v6
 
-      - name: "Deploy ${{ github.sha }} to AWS (dev)"
+      - name: "Deploy version ${{ github.sha }} to (dev)"
         timeout-minutes: 10
         uses: ./.github/actions/deploy
         with:

.github/workflows/cicd-3-deploy.yaml

@@ -30,7 +30,7 @@ jobs:
       id-token: write
       contents: read
     steps:
-      - name: "Check is ${{ github.ref }} a tag"
+      - name: "Check ref:${{ github.ref }} is a tag"
         run: |
           if ${{ !startsWith(github.ref, 'refs/tags/') }}; then
             echo "❌ Only tagged deployments allowed."

.github/workflows/cicd-4-promote.yaml

@@ -63,6 +63,7 @@ jobs:
 
   promote-stage:
     name: "Promote stage"
+    needs: [ metadata ]
     uses: ./.github/workflows/stage-6-promote.yaml
     with:
       environment: ${{ inputs.environment }}

.github/workflows/cicd-6-snapshot-update.yaml

@@ -32,7 +32,7 @@ jobs:
       IAM_ROLE: ${{ secrets.IAM_ROLE }}
 
     steps:
-      - name: "Configure AWS credentials for S3 upload"
+      - name: "Configure AWS credentials"
         uses: aws-actions/configure-aws-credentials@v5
         with:
           role-session-name: GitHubActionsSessionUpload

.github/workflows/cicd-7-hydrate-content-cache.yaml

@@ -14,7 +14,7 @@ env:
 
 jobs:
   hydrate:
-    name: "Hydrate content-cache: ${{inputs.environment}} env"
+    name: "Hydrate content-cache in (${{inputs.environment}})"
     runs-on: ubuntu-latest
     environment:
       name: ${{ inputs.environment }}
@@ -23,19 +23,19 @@ jobs:
       id-token: write
       contents: read
     steps:
-      - name: "Check ref"
+      - name: "Check ref:${{github.ref}} is a tag"
         run: |
           if ${{ !startsWith(github.ref, 'refs/tags/') }}; then
             echo "❌ Only tagged deployments allowed."
             exit 1
           fi
-      - name: "Configure AWS credentials for env"
+      - name: "Configure AWS credentials"
         uses: aws-actions/configure-aws-credentials@v5
         with:
           role-session-name: GitHubActionsSession
           role-to-assume: ${{ secrets.IAM_ROLE }}
           aws-region: ${{ env.AWS_REGION }}
-      - name: "Run content-cache-hydrator in ${{ inputs.environment}} environment"
+      - name: "Run content-cache-hydrator"
         run: |
           aws lambda invoke --function-name ${AWS_CONTENT_CACHE_HYDRATOR_LAMBDA} response.json || {
             echo "Invocation of Content Cache Hydrator failed"

.github/workflows/cicd-8-load-clinical-approved-changed-content.yaml

@@ -20,7 +20,7 @@ env:
 
 jobs:
   hydrate:
-    name: "Load new ${{inputs.vaccine_name}} content: ${{ inputs.environment }} env"
+    name: "Load new (${{inputs.vaccine_name}}) content in (${{ inputs.environment }})"
     runs-on: ubuntu-latest
     environment:
       name: ${{ inputs.environment }}
@@ -29,19 +29,19 @@ jobs:
       id-token: write
       contents: read
     steps:
-      - name: "Check ref"
+      - name: "Check ref:${{ github.ref }} is a tag"
         run: |
           if ${{ !startsWith(github.ref, 'refs/tags/') }}; then
             echo "❌ Only tagged deployments allowed."
             exit 1
           fi
-      - name: "Configure AWS credentials for env"
+      - name: "Configure AWS credentials"
         uses: aws-actions/configure-aws-credentials@v5
         with:
           role-session-name: GitHubActionsSession
           role-to-assume: ${{ secrets.IAM_ROLE }}
           aws-region: ${{ env.AWS_REGION }}
-      - name: "Run content-cache-hydrator for ${{ inputs.vaccine_name }} vaccine in ${{ inputs.environment }} environment"
+      - name: "Run content-cache-hydrator for (${{ inputs.vaccine_name }}) vaccine in (${{ inputs.environment }})"
         run: |
           aws lambda invoke --function-name ${AWS_CONTENT_CACHE_HYDRATOR_LAMBDA} --cli-binary-format 'raw-in-base64-out' --payload '{"forceUpdate": true, "vaccineToUpdate": "${{ inputs.vaccine_name}}"}' response.json || {
             echo "Invocation of Content Cache Hydrator failed"

.github/workflows/cicd-9-scheduled-assurance.yaml

@@ -47,7 +47,7 @@ jobs:
       - name: "Checkout code"
         uses: actions/checkout@v6
 
-      - name: "Deploy ${{ steps.get-latest-tag-name.outputs.value }} to AWS (preprod)"
+      - name: "Deploy version ${{ steps.get-latest-tag-name.outputs.value }} to (preprod)"
         timeout-minutes: 10
         uses: ./.github/actions/deploy
         with:
@@ -57,7 +57,7 @@ jobs:
           secret_aws_iam_role: ${{ secrets.IAM_ROLE }}
           secret_aws_slack_channel_id: ${{ secrets.ALARMS_SLACK_CHANNEL_ID }}
 
-      - name: "Run contract tests (sandpit+mocked)"
+      - name: "Run contract tests on ${{ steps.get-latest-tag-name.outputs.value }} (EliD:sandpit, EliD:mocked)"
         timeout-minutes: 3
         uses: ./.github/actions/run-contract-tests
         with:
@@ -147,7 +147,7 @@ jobs:
       - name: "Checkout code"
         uses: actions/checkout@v6
 
-      - name: "Deploy ${{ steps.get-latest-tag-name.outputs.value }} to AWS (preprod)"
+      - name: "Deploy version ${{ steps.get-latest-tag-name.outputs.value }} to (preprod)"
         timeout-minutes: 10
         uses: ./.github/actions/deploy
         with:
@@ -157,7 +157,7 @@ jobs:
           secret_aws_iam_role: ${{ secrets.IAM_ROLE }}
           secret_aws_slack_channel_id: ${{ secrets.ALARMS_SLACK_CHANNEL_ID }}
 
-      - name: "Run contract tests (sandpit+mocked)"
+      - name: "Run contract tests on ${{ steps.get-latest-tag-name.outputs.value }} (EliD:sandpit, EliD:mocked)"
         timeout-minutes: 3
         uses: ./.github/actions/run-contract-tests
         with:

.github/workflows/stage-5-acceptance.yaml

@@ -49,7 +49,7 @@ jobs:
         with:
           ref: ${{ inputs.checkout_ref }}
 
-      - name: "Configure AWS credentials for env"
+      - name: "Configure AWS credentials"
         uses: aws-actions/configure-aws-credentials@v5
         with:
           role-session-name: GitHubActionsSession
@@ -67,7 +67,7 @@ jobs:
             exit 1
           fi
 
-      - name: "Run E2E tests for version - ${{ inputs.checkout_ref }}"
+      - name: "Run E2E tests for version ${{ inputs.checkout_ref }}"
         timeout-minutes: 10
         uses: ./.github/actions/run-e2e-tests
         with:
@@ -95,7 +95,7 @@ jobs:
         with:
           ref: ${{ inputs.checkout_ref }}
 
-      - name: "Run contract tests for version - ${{ inputs.checkout_ref }} (EliD:sandpit, EliD:mocked)"
+      - name: "Run contract tests for version ${{ inputs.checkout_ref }} (EliD:sandpit, EliD:mocked)"
         timeout-minutes: 3
         uses: ./.github/actions/run-contract-tests
         with:

.github/workflows/stage-6-promote.yaml

@@ -48,7 +48,7 @@ jobs:
           role-session-name: GitHubActionsSession
           role-to-assume: ${{ secrets.IAM_ROLE }}
           aws-region: ${{ env.AWS_REGION }}
-      - name: "Download artefacts from source"
+      - name: "Download artefacts from source for version ${{ inputs.release_tag }}"
         env:
           AWS_S3_SOURCE_RELEASES_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-releases-${{ env.ENVIRONMENT }}
         run: |
@@ -85,7 +85,7 @@ jobs:
           role-session-name: GitHubActionsSession
           role-to-assume: ${{ secrets.IAM_ROLE }}
           aws-region: ${{ env.AWS_REGION }}
-      - name: "Upload artefacts to target"
+      - name: "Upload artefacts to target for version ${{ inputs.release_tag }}"
         env:
           AWS_S3_TARGET_RELEASES_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-releases-${{ inputs.environment }}
         run: |