Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sbstjn/cfn-release-example

Continuous Integration and Deployment for CloudFormation Templates using AWS CDK and GitHub Actions.
https://github.com/sbstjn/cfn-release-example

actions aws cdk cloudformation example github tooling

Last synced: about 1 month ago
JSON representation

Continuous Integration and Deployment for CloudFormation Templates using AWS CDK and GitHub Actions.

Host: GitHub
URL: https://github.com/sbstjn/cfn-release-example
Owner: sbstjn
License: mit
Created: 2020-11-12T13:29:21.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2020-11-16T18:52:03.000Z (about 4 years ago)
Last Synced: 2024-11-09T20:45:03.596Z (3 months ago)
Topics: actions, aws, cdk, cloudformation, example, github, tooling
Language: TypeScript
Homepage:
Size: 584 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Publish CloudFormation Templates with CDK

[![MIT License](https://badgen.now.sh/badge/License/MIT/purple?1)](https://github.com/sbstjn/cfn-release-example/blob/master/LICENSE.md)

[![MIT License](https://badgen.net/github/release/sbstjn/cfn-release-example?1)](https://github.com/sbstjn/cfn-release-example/releases)

> Run **Continuous Integration** and **Continuous Deployment** with [GitHub Actions](actions) for CloudFormation Templates and the [AWS Cloud Development Kit](https://aws.amazon.com/cdk/). Use `git tags` to manage [GitHub Releases](releases) and upload static YAML files to S3 for AWS integrations.

When orchestrating AWS services, you might end up needing a static CloudFormation Template stored in an S3 Bucket. The basic tools for CloudFormation Templates can be frustrating and building a pipeline to manage static files, is boring as hell. Thanks to the [AWS Cloud Development Kit](https://aws.amazon.com/cdk/) and GitHub Actions, you can run a pretty neat pipeline to deploy static CloudFormation Templates.

**tl;dr:** _Use the AWS CDK to build a static YAML file and deploy it to S3._

## Workflow

Use the the **CDK** to create a CloudFormation Stack.

### Integration

A [GitHub Action in `integration.yml`](.github/workflows/integration.yml) runs `cdk build` on every `push` event.

### Release

A [GitHub Action in `release.yml`](.github/workflows/release.yml) creates a **GitHub Release** for every `tag` matching `v0.1.0` pattern.

### Deployment

The static **YAML** file is uploaded to the **GitHub Release** and your **S3 Bucket**.

## Configuration

You need to set the following `secrets` for your repository:

- `AWS_BUCKET_NAME`

- `AWS_BUCKET_REGION`

- `AWS_KEY_ID`

- `AWS_SECRET_ACCESS_KEY`