Add CodeDeploy deployment description as parameter (aws-actions#200)

* feat: CodeDeploy deployment description parameter

* Remove reference to default value in parameter description

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: Louisblack

action.yml

@@ -28,6 +28,9 @@ inputs:
   codedeploy-deployment-group:
     description: "The name of the AWS CodeDeploy deployment group, if the ECS service uses the CODE_DEPLOY deployment controller. Will default to 'DgpECS-{cluster}-{service}'."
     required: false
+  codedeploy-deployment-description:
+    description: "A description of the deployment, if the ECS service uses the CODE_DEPLOY deployment controller."
+    required: false
   force-new-deployment:
     description: 'Whether to force a new deployment of the service. Valid value is "true". Will default to not force a new deployment.'
     required: false

index.js

@@ -172,6 +172,8 @@ async function createCodeDeployDeployment(codedeploy, clusterName, service, task
   let codeDeployGroup = core.getInput('codedeploy-deployment-group', { required: false });
   codeDeployGroup = codeDeployGroup ? codeDeployGroup : `DgpECS-${clusterName}-${service}`;
 
+  let codeDeployDescription = core.getInput('codedeploy-deployment-description', { required: false });
+
   let deploymentGroupDetails = await codedeploy.getDeploymentGroup({
     applicationName: codeDeployApp,
     deploymentGroupName: codeDeployGroup
@@ -199,7 +201,7 @@ async function createCodeDeployDeployment(codedeploy, clusterName, service, task
 
   // Start the deployment with the updated appspec contents
   core.debug('Starting CodeDeploy deployment');
-  const createDeployResponse = await codedeploy.createDeployment({
+  let deploymentParams = {
     applicationName: codeDeployApp,
     deploymentGroupName: codeDeployGroup,
     revision: {
@@ -209,7 +211,12 @@ async function createCodeDeployDeployment(codedeploy, clusterName, service, task
         sha256: appSpecHash
       }
     }
-  }).promise();
+  };
+  // If it hasn't been set then we don't even want to pass it to the api call to maintain previous behaviour.
+  if (codeDeployDescription) {
+    deploymentParams.description = codeDeployDescription
+  }
+  const createDeployResponse = await codedeploy.createDeployment(deploymentParams).promise();
   core.setOutput('codedeploy-deployment-id', createDeployResponse.deploymentId);
   core.info(`Deployment started. Watch this deployment's progress in the AWS CodeDeploy console: https://console.aws.amazon.com/codesuite/codedeploy/deployments/${createDeployResponse.deploymentId}?region=${aws.config.region}`);
 

index.test.js

@@ -752,6 +752,90 @@ describe('Deploy to ECS', () => {
         expect(mockEcsWaiter).toHaveBeenCalledTimes(0);
     });
 
+    test('registers the task definition contents and creates a CodeDeploy deployment with custom application, deployment group and description', async () => {
+        core.getInput = jest
+            .fn(input => {
+                return {
+                    'task-definition': 'task-definition.json',
+                    'service': 'service-456',
+                    'cluster': 'cluster-789',
+                    'wait-for-service-stability': 'TRUE',
+                    'codedeploy-application': 'Custom-Application',
+                    'codedeploy-deployment-group': 'Custom-Deployment-Group',
+                    'codedeploy-deployment-description': 'Custom-Deployment'
+                }[input];
+            });
+
+        mockEcsDescribeServices.mockImplementation(() => {
+            return {
+                promise() {
+                    return Promise.resolve({
+                        failures: [],
+                        services: [{
+                            status: 'ACTIVE',
+                            deploymentController: {
+                                type: 'CODE_DEPLOY'
+                            }
+                        }]
+                    });
+                }
+            };
+        });
+
+        await run();
+        expect(core.setFailed).toHaveBeenCalledTimes(0);
+
+        expect(mockEcsRegisterTaskDef).toHaveBeenNthCalledWith(1, { family: 'task-def-family'});
+        expect(core.setOutput).toHaveBeenNthCalledWith(1, 'task-definition-arn', 'task:def:arn');
+        expect(mockEcsDescribeServices).toHaveBeenNthCalledWith(1, {
+            cluster: 'cluster-789',
+            services: ['service-456']
+        });
+
+        expect(mockCodeDeployCreateDeployment).toHaveBeenNthCalledWith(1, {
+            applicationName: 'Custom-Application',
+            deploymentGroupName: 'Custom-Deployment-Group',
+            description: 'Custom-Deployment',
+            revision: {
+                revisionType: 'AppSpecContent',
+                appSpecContent: {
+                    content: JSON.stringify({
+                        Resources: [{
+                            TargetService: {
+                                Type: 'AWS::ECS::Service',
+                                Properties: {
+                                    TaskDefinition: 'task:def:arn',
+                                    LoadBalancerInfo: {
+                                        ContainerName: "web",
+                                        ContainerPort: 80
+                                    }
+                                }
+                            }
+                        }]
+                    }),
+                    sha256: '0911d1e99f48b492e238d1284d8ddb805382d33e1d1fc74ffadf37d8b7e6d096'
+                }
+            }
+        });
+
+        expect(mockCodeDeployWaiter).toHaveBeenNthCalledWith(1, 'deploymentSuccessful', {
+            deploymentId: 'deployment-1',
+            $waiter: {
+                delay: 15,
+                maxAttempts: (
+                    EXPECTED_DEFAULT_WAIT_TIME +
+                    EXPECTED_CODE_DEPLOY_TERMINATION_WAIT_TIME +
+                    EXPECTED_CODE_DEPLOY_DEPLOYMENT_READY_WAIT_TIME
+                ) * 4
+            }
+        });
+
+        expect(mockEcsUpdateService).toHaveBeenCalledTimes(0);
+        expect(mockEcsWaiter).toHaveBeenCalledTimes(0);
+
+        expect(core.info).toBeCalledWith("Deployment started. Watch this deployment's progress in the AWS CodeDeploy console: https://console.aws.amazon.com/codesuite/codedeploy/deployments/deployment-1?region=fake-region");
+    });
+
      test('registers the task definition contents at an absolute path', async () => {
         core.getInput = jest.fn().mockReturnValueOnce('/hello/task-definition.json');
         fs.readFileSync.mockImplementation((pathInput, encoding) => {