/cfn-deploy

A useful GitHub Action to help you deploy cloudformation templates

Primary LanguageShellMIT LicenseMIT

cfn-deploy

cfn-deploy

A simple github action to deploy cloudformation yaml files to AWS

Usage

An example workflow for deploying a cloudformation template follows.

 - uses: intuit/cfn-deploy@master
      env:
        AWS_REGION: us-east-2
        STACK_NAME: cfn-deploy
        TEMPLATE_FILE: ec2.yml
        PARAMETERS_FILE: parameter.json
        CAPABLITIES: CAPABILITY_IAM
        AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
        AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

Secrets

  • AWS_ACCESS_KEY_ID – (Required) The AWS access key part of your credentials more info

  • AWS_SECRET_ACCESS_KEY – (Required) The AWS secret access key part of your credentials more info

Environment variables

All environment variables listed in the official documentation are supported.

The custom env variables to be added are:

AWS_REGION - Region to which you need to deploy your app
STACK_NAME - Cloudformation Stack Name
TEMPLATE_FILE - Cloudformation template yaml file
PARAMETERS_FILE - Input parameters to the cloudformation stack as json file
CAPABLITIES - IAM capablities for the cloudformation stack

Optional

WAIT_TIMEOUT - Timeout in seconds to exit from "wait" of create/update stack.

Contributing

See Contributing