Fix YAML native parameters and tags

.lintstagedrc.js

@@ -1,11 +1,10 @@
 module.exports = {
-    // Prettier
-    '**/*.{md}': ['prettier --ignore-path .gitignore --write'],
-
-    // Eslint
-    '**/*.{ts,tsx}': ['eslint --fix'],
-
-    // Jest
-    '**/*.test.{ml,mli,mly,ts,js,json}': 'jest',
-  }
-
+  // Prettier
+  '**/*.{md}': ['prettier --ignore-path .gitignore --write'],
+
+  // Eslint
+  '**/*.{ts,tsx}': ['eslint --fix'],
+
+  // Jest
+  '**/*.test.{ml,mli,mly,ts,js,json}': 'jest'
+}

CHANGELOG.md

@@ -4,8 +4,24 @@ All notable changes to this project will be documented in this file. See [standa
 
 ## Features
 
-#12, #13 Supporting more input parameters
-#17 Use stack name to filter for current stack
-#23 Output to GitHub actions
+### 1.6.1 , 1.6.2
+
+- Change log updates
+
+### 1.6.0
+
+- Added support for change set description
+- Added support for YAML output format
+- Added Retry for Rate Limit Exception
+
+### 1.5.0
+
+- Added support for YAML input format
+
+### older versions
+
+- #12, #13 Supporting more input parameters
+- #17 Use stack name to filter for current stack
+- #23 Output to GitHub actions
 
 ## Bug Fixes

README.md

@@ -1,4 +1,5 @@
-## AWS CloudFormation "Deploy CloudFormation Stack" Action for GitHub Actions
+<!-- trunk-ignore-all(prettier/SyntaxError) -->
+# AWS CloudFormation "Deploy CloudFormation Stack" Action for GitHub Actions
 
 ![Package](https://github.com/aws-actions/aws-cloudformation-github-deploy/workflows/Package/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -24,13 +25,27 @@ A few inputs are highlighted below. See [action.yml](action.yml) for the full do
 
 #### parameter-overrides (OPTIONAL)
 
-To override parameter values in the template you can provide a string or a file that is either local or an URL.
+To override parameter values in the template you can provide a string, a file that is either local or an URL, or a native YAML object.
 
 Override multiple parameters separated by commas: `"MyParam1=myValue1,MyParam2=myValue2"`
 
 Override a comma delimited list: `"MyParam1=myValue1,MyParam1=myValue2"` or `MyParam1="myValue1,myValue2"`
 
+Override parameters using a almost native YAML object :
+
+```yaml
+parameter-overrides: |
+  MyParam1: myValue1
+  MyParam2: myValue2
+  MyListParam:
+    - item1
+    - item2
+```
+
+**!Note** GitHub Actions requre all parameters to be a string, but we can pass a YAML object via string.
+
 Override parameters using a local JSON file: `"file:///${{ github.workspace }}/parameters.json"` with a file named `parameters.json` at the root of the repository:
+
 ```json
 [
   {
@@ -42,6 +57,64 @@ Override parameters using a local JSON file: `"file:///${{ github.workspace }}/p
 
 > You can learn more about [AWS CloudFormation](https://aws.amazon.com/cloudformation/)
 
+## Setting Tags
+
+You can add tags to your CloudFormation stack by using the `tags` parameter. Tags can be specified in three formats:
+
+Using YAML array format:
+
+```yaml
+- uses: aws-actions/aws-cloudformation-github-deploy@v1
+  with:
+    name: MyStack
+    template: myStack.yaml
+    tags: |
+      - Key: Environment
+        Value: Production
+      - Key: Team
+        Value: DevOps
+```
+
+**!Note** GitHub Actions requre all parameters to be a string, but we can pass a YAML object via string.
+
+Using YAML object format:
+
+```yaml
+- uses: aws-actions/aws-cloudformation-github-deploy@v1
+  with:
+    name: MyStack
+    template: myStack.yaml
+    tags: |
+      Environment: Production
+      Team: DevOps
+```
+
+**!Note** GitHub Actions requre all parameters to be a string, but we can pass a YAML object via string.
+
+Using JSON formating:
+
+```yaml
+- uses: aws-actions/aws-cloudformation-github-deploy@v1
+  with:
+    name: MyStack
+    template: myStack.yaml
+    tags: |
+      [
+        {
+          "Key": "Environment",
+          "Value": "Production"
+        },
+        {
+          "Key": "Team",
+          "Value": "DevOps"
+        }
+      ]
+```
+
+**!Note** GitHub Actions requre all parameters to be a string, but we can pass a JSON object via string.
+
+Tags specified during stack creation or update will be applied to the stack and all its resources that support tagging. These tags can be useful for cost allocation, access control, and resource organization.
+
 ## Credentials and Region
 
 This action relies on the [default behavior of the AWS SDK for Javascript](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) to determine AWS credentials and region.
@@ -61,7 +134,7 @@ This action requires the following minimum set of permissions:
 
 > We recommend to read [AWS CloudFormation Security Best Practices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html)
 
-```
+```json
 {
     "Version": "2012-10-17",
     "Statement": [
@@ -137,15 +210,19 @@ jobs:
         name: ${{ steps.env-name.outputs.environment }}-cluster
         template: https://s3.amazonaws.com/aws-quickstart/quickstart-amazon-eks/templates/amazon-eks-master.template.yaml
         no-fail-on-empty-changeset: "1"
-        parameter-overrides: >-
-          AvailabilityZones=${{ github.event.inputs.region }}a,
-          AvailabilityZones=${{ github.event.inputs.region }}c,
-          KeyPairName=${{ github.event.inputs.keypair }},
-          NumberOfAZs=2,
-          ProvisionBastionHost=Disabled,
-          EKSPublicAccessEndpoint=Enabled,
-          EKSPrivateAccessEndpoint=Enabled,
-          RemoteAccessCIDR=0.0.0.0/0
+        parameter-overrides: |
+          AvailabilityZones:
+            - ${{ github.event.inputs.region }}a
+            - ${{ github.event.inputs.region }}c
+          KeyPairName: ${{ github.event.inputs.keypair }}
+          NumberOfAZs: 2
+          ProvisionBastionHost: Disabled
+          EKSPublicAccessEndpoint: Enabled
+          EKSPrivateAccessEndpoint: Enabled
+          RemoteAccessCIDR: 0.0.0.0/0
+        tags: |
+          Environmnet: Develop
+          Owner: DevOps
 
 ```
 
@@ -156,6 +233,7 @@ If you run in self-hosted environments and in secured environment where you need
 Additionally this action will always consider already configured proxy in the environment.
 
 Manually configured proxy:
+
 ```yaml
 uses: aws-actions/aws-cloudformation-github-deploy@v1
 with:

__tests__/main.test.ts

@@ -931,6 +931,85 @@ describe('Deploy CloudFormation Stack', () => {
     expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
   })
 
+  test('deploys the stack with change set description', async () => {
+    const inputs: Inputs = {
+      name: 'MockStack',
+      template: 'template.yaml',
+      capabilities: 'CAPABILITY_IAM',
+      'parameter-overrides': 'AdminEmail=no-reply@amazon.com',
+      'no-fail-on-empty-changeset': '0',
+      'change-set-description': 'My test change set description'
+    }
+
+    jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
+      return inputs[name]
+    })
+
+    mockCfnClient
+      .reset()
+      .on(DescribeStacksCommand)
+      .resolvesOnce({
+        Stacks: [
+          {
+            StackId: mockStackId,
+            Tags: [],
+            Outputs: [],
+            StackStatusReason: '',
+            CreationTime: new Date('2013-08-23T01:02:15.422Z'),
+            Capabilities: [],
+            StackName: 'MockStack',
+            StackStatus: 'CREATE_COMPLETE'
+          }
+        ]
+      })
+      .resolves({
+        Stacks: [
+          {
+            StackId: mockStackId,
+            Tags: [],
+            Outputs: [],
+            StackStatusReason: '',
+            CreationTime: new Date('2013-08-23T01:02:15.422Z'),
+            Capabilities: [],
+            StackName: 'MockStack',
+            StackStatus: StackStatus.UPDATE_COMPLETE
+          }
+        ]
+      })
+      .on(CreateChangeSetCommand)
+      .resolves({})
+      .on(ExecuteChangeSetCommand)
+      .resolves({})
+      .on(DescribeChangeSetCommand)
+      .resolves({ Status: ChangeSetStatus.CREATE_COMPLETE })
+
+    await run()
+
+    expect(core.setFailed).toHaveBeenCalledTimes(0)
+    expect(mockCfnClient).toHaveReceivedCommandTimes(DescribeStacksCommand, 3)
+    expect(mockCfnClient).toHaveReceivedNthCommandWith(
+      2,
+      CreateChangeSetCommand,
+      {
+        StackName: 'MockStack',
+        TemplateBody: mockTemplate,
+        Capabilities: ['CAPABILITY_IAM'],
+        Parameters: [
+          { ParameterKey: 'AdminEmail', ParameterValue: 'no-reply@amazon.com' }
+        ],
+        ChangeSetName: 'MockStack-CS',
+        Description: 'My test change set description',
+        NotificationARNs: undefined,
+        ResourceTypes: undefined,
+        RollbackConfiguration: undefined,
+        RoleARN: undefined,
+        Tags: undefined
+      }
+    )
+    expect(core.setOutput).toHaveBeenCalledTimes(1)
+    expect(core.setOutput).toHaveBeenNthCalledWith(1, 'stack-id', mockStackId)
+  })
+
   test('successfully update the stack', async () => {
     mockCfnClient
       .reset()