Sceptre Github CI Action

This GitHub action allows you to simply executre Sceptre commands within Github actions, without needing to handle any installation of pip modules.

The action supports all commands and template types, including Troposphere.

It is possible to use this action on a self-hosted runner, provided the runner has docker installed. See the GitHub action Docs for more info.

Compatibility

Requires:

• Sceptre Version >2
• Troposphere Version >2 (If used)

Environment Variables

To use this action you must specify the following environment variables for the runner used to execute the action:

AWS_ACCESS_KEY_ID
# Specifies an AWS access key associated with an IAM user or role.

AWS_SECRET_ACCESS_KEY
# Specifies the secret key associated with the access key. This is essentially
the "password" for the access key.

Optionally, you can provide these environment variables:

AWS_DEFAULT_REGION
# Specifies the AWS Region to send the request to. Only required if you haven't
specified this in your stack config files.

Usage

Here are two quick examples for some common workflows. Both workflows assume a Sceptre structure like so:

.
├── config
│   ├── config.yaml
│   ├── dev
│   │   └── ecr.yaml
│   └── prod
│       └── ecr.yaml
└── templates
    └── ecr.yaml

# Function: Validate stacks against the 'dev' environment
# Trigger: Pull Request created
name: 'Sceptre Github CI Action'
on:
  - pull_request
env:
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
jobs:
  sceptre:
    name: 'Sceptre'
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout'
        uses: actions/checkout@master

      - name: 'Sceptre Validate'
        uses: Sceptre/github-ci-action@master
        with:
          sceptre_version: '2.5.0'
          sceptre_subcommand: 'validate dev'

# Function: Validate stacks, then launch all stacks in the 'dev' environment
# Trigger: Push/Merge to 'develop' branch
# Plugins: sceptre-ssm-resolver from PyPI and sceptre-cmd-resolver from GitHub
name: 'Sceptre Github CI Action'
on:
  push:
    branches:
      - develop
env:
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
jobs:
  sceptre:
    name: 'Sceptre'
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout'
        uses: actions/checkout@master

      - name: 'Sceptre Validate'
        uses: Sceptre/github-ci-action@master
        with:
          sceptre_version: '2.5.0'
          sceptre_subcommand: 'validate dev'

      - name: 'Sceptre launch'
        uses: Sceptre/github-ci-action@master
        with:
          sceptre_version: '2.5.0'
          sceptre_plugins: >-
            sceptre-ssm-resolver==1.1.4
            git+https://github.com/Sceptre/sceptre-resolver-cmd.git@master
          sceptre_subcommand: 'launch -y dev'

Acknowledgments

This is a fork of the Sceptre Github Action developed by Robbie Urquhart

References

• Sceptre Documentation
• GitHub Actions Documentation