From fca44ee718f703e5416bb0e59b3bd760135205aa Mon Sep 17 00:00:00 2001
From: Roy Wong <hpractv@groundworksdesign.com>
Date: Tue, 6 Feb 2024 14:03:38 -0700
Subject: [PATCH] Added required deployment description

---
 .github/workflows/im-reusable-finish-deployment-workflow.yml     | 1 +
 workflow-templates/im-deploy-files-to-az-storage-account.yml     | 1 +
 .../im-deploy-tf-auto-apply-main-to-dev-on-merge.yml             | 1 +
 3 files changed, 3 insertions(+)

diff --git a/.github/workflows/im-reusable-finish-deployment-workflow.yml b/.github/workflows/im-reusable-finish-deployment-workflow.yml
index c845ebe5..7488c9d8 100644
--- a/.github/workflows/im-reusable-finish-deployment-workflow.yml
+++ b/.github/workflows/im-reusable-finish-deployment-workflow.yml
@@ -143,6 +143,7 @@ jobs:
           environment: ${{ inputs.deployment-environment }}
           release-ref: ${{ inputs.release-tag }}
           deployment-status: ${{ steps.conclusion.outputs.workflow_conclusion }}
+          deployment-description: 'Deployment to the ${{ inputs.deployment-environment }} environment of ${{ inputs.release-tag }}'
           entity: ${{ inputs.entity }}
           instance: ${{ inputs.instance || inputs.target-slot }}
 
diff --git a/workflow-templates/im-deploy-files-to-az-storage-account.yml b/workflow-templates/im-deploy-files-to-az-storage-account.yml
index 9cceb08c..ce45f029 100644
--- a/workflow-templates/im-deploy-files-to-az-storage-account.yml
+++ b/workflow-templates/im-deploy-files-to-az-storage-account.yml
@@ -108,6 +108,7 @@ jobs:
           environment: ${{ env.ENVIRONMENT }}
           release-ref: ${{ env.GITHUB_REF }}
           deployment-status: ${{ job.status }}
+          deployment-description: 'Deployment to the ${{ env.ENVIRONMENT }} environment of ${{ env.GITHUB_REF }}'
           entity: '' # TODO: Fill this out with the catalog-info.yml's metadata.name value
           instance: file-storage
 
diff --git a/workflow-templates/im-deploy-tf-auto-apply-main-to-dev-on-merge.yml b/workflow-templates/im-deploy-tf-auto-apply-main-to-dev-on-merge.yml
index 3b986686..cc1b5d5b 100644
--- a/workflow-templates/im-deploy-tf-auto-apply-main-to-dev-on-merge.yml
+++ b/workflow-templates/im-deploy-tf-auto-apply-main-to-dev-on-merge.yml
@@ -146,5 +146,6 @@ jobs:
           environment: 'Dev'
           release-ref: 'main'
           deployment-status: ${{ job.status }}
+          deployment-description: 'Deployment to the Dev environment of the main branch'
           entity: '' # TODO: Fill this out with the catalog-info.yml's metadata.name value
           instance: ${{ inputs.instance }}