(feat) output change set id

__tests__/main.test.ts

@@ -30,6 +30,8 @@ Outputs:
 
 const mockStackId =
   'arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896'
+const mockChangeSetId =
+  'arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0'
 
 const mockCreateStack = jest.fn()
 const mockUpdateStack = jest.fn()
@@ -115,15 +117,19 @@ describe('Deploy CloudFormation Stack', () => {
     mockCreateChangeSet.mockImplementation(() => {
       return {
         promise(): Promise<aws.CloudFormation.Types.CreateChangeSetOutput> {
-          return Promise.resolve({})
+          return Promise.resolve({
+            Id: mockChangeSetId
+          })
         }
       }
     })
 
     mockDescribeChangeSet.mockImplementation(() => {
       return {
         promise(): Promise<aws.CloudFormation.Types.DescribeChangeSetOutput> {
-          return Promise.resolve({})
+          return Promise.resolve({
+            ChangeSetId: mockChangeSetId
+          })
         }
       }
     })
@@ -204,8 +210,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('sets the stack outputs as action outputs', async () => {
@@ -269,10 +280,15 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(3)
+    expect(core.setOutput).toHaveBeenCalledTimes(4)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
-    expect(core.setOutput).toHaveBeenNthCalledWith(2, 'hello', 'world')
-    expect(core.setOutput).toHaveBeenNthCalledWith(3, 'foo', 'bar')
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
+    expect(core.setOutput).toHaveBeenNthCalledWith(3, 'hello', 'world')
+    expect(core.setOutput).toHaveBeenNthCalledWith(4, 'foo', 'bar')
   })
 
   test('deploys the stack with template url', async () => {
@@ -311,8 +327,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('deploys the stack with termination protection', async () => {
@@ -352,8 +373,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: true
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('deploys the stack with disabling rollback', async () => {
@@ -393,8 +419,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: true,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('deploys the stack with Notification ARNs', async () => {
@@ -439,8 +470,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('deploys the stack with Role ARN', async () => {
@@ -481,8 +517,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('deploys the stack with tags', async () => {
@@ -523,8 +564,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('deploys the stack with timeout', async () => {
@@ -565,8 +611,13 @@ describe('Deploy CloudFormation Stack', () => {
       DisableRollback: false,
       EnableTerminationProtection: false
     })
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      'UNKNOWN'
+    )
   })
 
   test('successfully update the stack', async () => {
@@ -625,6 +676,14 @@ describe('Deploy CloudFormation Stack', () => {
       StackName: 'MockStack'
     })
     expect(mockCfnWaiter).toHaveBeenCalledTimes(2)
+
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      mockChangeSetId
+    )
   })
 
   test('no execute change set on update the stack', async () => {
@@ -692,6 +751,14 @@ describe('Deploy CloudFormation Stack', () => {
     })
     expect(mockExecuteChangeSet).toHaveBeenCalledTimes(0)
     expect(mockCfnWaiter).toHaveBeenCalledTimes(1)
+
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      mockChangeSetId
+    )
   })
 
   test('error is caught updating if create change fails', async () => {
@@ -857,7 +924,13 @@ describe('Deploy CloudFormation Stack', () => {
     await run()
 
     expect(core.setFailed).toHaveBeenCalledTimes(0)
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      mockChangeSetId
+    )
     expect(mockDescribeStacks).toHaveBeenCalledTimes(2)
     expect(mockDescribeStacks).toHaveBeenNthCalledWith(1, {
       StackName: 'MockStack'
@@ -964,7 +1037,13 @@ describe('Deploy CloudFormation Stack', () => {
     await run()
 
     expect(core.setFailed).toHaveBeenCalledTimes(0)
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      mockChangeSetId
+    )
     expect(mockDescribeStacks).toHaveBeenCalledTimes(2)
     expect(mockDescribeStacks).toHaveBeenNthCalledWith(1, {
       StackName: 'MockStack'
@@ -1164,7 +1243,13 @@ describe('Deploy CloudFormation Stack', () => {
     await run()
 
     expect(core.setFailed).toHaveBeenCalledTimes(0)
-    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenCalledTimes(2)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'change-set-id',
+      mockChangeSetId
+    )
     expect(mockDescribeStacks).toHaveBeenCalledTimes(2)
     expect(mockDescribeStacks).toHaveBeenNthCalledWith(1, {
       StackName: 'MockStack'

action.yml

@@ -52,6 +52,8 @@ inputs:
 outputs:
   stack-id:
     description: "The id of the deployed stack. In addition, any outputs declared in the deployed CloudFormation stack will also be set as outputs for the action, e.g. if the stack has a stack output named 'foo', this action will also have an output named 'foo'."
+  change-set-id:
+    description: "The id of the created change set. If no change set was created, defaults to 'UNKNOWN'"
 runs:
   using: "node12"
   main: "dist/index.js"

src/deploy.ts

@@ -4,13 +4,18 @@ import { CreateChangeSetInput, CreateStackInput } from './main'
 
 export type Stack = aws.CloudFormation.Stack
 
+interface IdOutputs {
+  StackId?: string
+  ChangeSetId?: string
+}
+
 export async function cleanupChangeSet(
   cfn: aws.CloudFormation,
   stack: Stack,
   params: CreateChangeSetInput,
   noEmptyChangeSet: boolean,
   noDeleteFailedChangeSet: boolean
-): Promise<string | undefined> {
+): Promise<IdOutputs> {
   const knownErrorMessages = [
     `No updates are to be performed`,
     `The submitted information didn't contain changes`
@@ -41,13 +46,20 @@ export async function cleanupChangeSet(
         changeSetStatus.StatusReason?.includes(err)
       )
     ) {
-      return stack.StackId
+      return {
+        StackId: stack.StackId,
+        ChangeSetId: changeSetStatus.ChangeSetId
+      }
     }
 
     throw new Error(
       `Failed to create Change Set: ${changeSetStatus.StatusReason}`
     )
   }
+  return {
+    StackId: stack.StackId,
+    ChangeSetId: changeSetStatus.ChangeSetId
+  }
 }
 
 export async function updateStack(
@@ -57,9 +69,9 @@ export async function updateStack(
   noEmptyChangeSet: boolean,
   noExecuteChageSet: boolean,
   noDeleteFailedChangeSet: boolean
-): Promise<string | undefined> {
+): Promise<IdOutputs> {
   core.debug('Creating CloudFormation Change Set')
-  await cfn.createChangeSet(params).promise()
+  const createChangeSet = await cfn.createChangeSet(params).promise()
 
   try {
     core.debug('Waiting for CloudFormation Change Set creation')
@@ -81,7 +93,10 @@ export async function updateStack(
 
   if (noExecuteChageSet) {
     core.debug('Not executing the change set')
-    return stack.StackId
+    return {
+      StackId: stack.StackId,
+      ChangeSetId: createChangeSet.Id
+    }
   }
 
   core.debug('Executing CloudFormation change set')
@@ -97,7 +112,10 @@ export async function updateStack(
     .waitFor('stackUpdateComplete', { StackName: stack.StackId })
     .promise()
 
-  return stack.StackId
+  return {
+    StackId: stack.StackId,
+    ChangeSetId: createChangeSet.Id
+  }
 }
 
 async function getStack(
@@ -125,7 +143,7 @@ export async function deployStack(
   noEmptyChangeSet: boolean,
   noExecuteChageSet: boolean,
   noDeleteFailedChangeSet: boolean
-): Promise<string | undefined> {
+): Promise<IdOutputs> {
   const stack = await getStack(cfn, params.StackName)
 
   if (!stack) {
@@ -136,7 +154,9 @@ export async function deployStack(
       .waitFor('stackCreateComplete', { StackName: params.StackName })
       .promise()
 
-    return stack.StackId
+    return {
+      StackId: stack.StackId
+    }
   }
 
   return await updateStack(

src/main.ts

@@ -115,17 +115,18 @@ export async function run(): Promise<void> {
       params.Parameters = parseParameters(parameterOverrides.trim())
     }
 
-    const stackId = await deployStack(
+    const deployStackOutputs = await deployStack(
       cfn,
       params,
       noEmptyChangeSet,
       noExecuteChageSet,
       noDeleteFailedChangeSet
     )
-    core.setOutput('stack-id', stackId || 'UNKNOWN')
+    core.setOutput('stack-id', deployStackOutputs.StackId || 'UNKNOWN')
+    core.setOutput('change-set-id', deployStackOutputs.ChangeSetId || 'UNKNOWN')
 
-    if (stackId) {
-      const outputs = await getStackOutputs(cfn, stackId)
+    if (deployStackOutputs.StackId) {
+      const outputs = await getStackOutputs(cfn, deployStackOutputs.StackId)
       for (const [key, value] of outputs) {
         core.setOutput(key, value)
       }