dtt101 / aws-cfn-deploy-action

Github Action to deploy Cloudformation stacks to AWS.

AWS Cloudformation Deploy Action

This action deploys AWS Cloudformation Stacks through yaml files.

Usage

name: "Deploy Cloudformation Stack to Production"
on: 
 push:
    branches:
    - master

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: university-of-york/aws-cfn-deploy-action@v1.0
      env:
        TEMPLATE: 'cloudformation/template.yaml'
        PARAMETER_FILE: 'cloudformation/configs/config-production.json'
        AWS_STACK_NAME: 'my-stack-name'
        AWS_REGION: 'eu-west-1'
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        ROLE_ARN: 'arn:aws:iam::012345678912:role/DeploymentRole'

Parameter Config File

A JSON based parameter file can be used to cleanly translate parameters to the Cloudformation Key1=Value1 Key2=Value2 format.

Create a JSON file, structured without a trailing comma with the Key and Value of each parameter you wish to pass, referencing the relative path to this file in the action using PARAMETER_FILE.

{
    "Bucket" : "my-test-bucket",
    "Name" : "my-other-thing"
}

Environment Variables

• TEMPLATE - [Optional]. YML file containing CloudFormation Stack.
  • Type: string
  • Default: template.yml
• CAPABILITIES - [Optional]. AWS Stack Capabilites.
  • Type: string
  • Default: CAPABILITY_IAM
• AWS_STACK_NAME - [Required]. The Stack name that is going to be published.
  • Type: string
• AWS_REGION - [Required]. AWS Region where to deploy the CloudFormation Stack.
  • Type: string
• AWS_ACCESS_KEY_ID - [Required]. AWS Access Key Id.
  • Type: string
• AWS_SECRET_ACCESS_KEY - [Required]. AWS Secret Access Key.
  • Type: string
• AWS_DEPLOY_BUCKET - [Required]. AWS S3 Bucket where the Stack package is going to be stored.
  • Type: string
• AWS_BUCKET_PREFIX - [Optional]. S3 Bucket's folder where to upload the package.
  • Type: string
• FORCE_UPLOAD - [Optional]. Whether to override existing packages in case they are an exact match.
  • Type: boolean
• USE_JSON - [Optional]. Whether to use JSON instead of YML as the output template format.
  • Type: boolean
• PARAMETER_FILE - [Optional]. Relative path to a JSON config file.
  • Type: string | list[string]
• TAGS - [Optional]. Tags to assign.
  • Type: string | list[string]
  • Syntax: Environment=prod Name=infrastructure
• ROLE_ARN - [Optional]. The full role ARN to use for the deploy step
  • Type: string

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.