{"id":19274112,"url":"https://github.com/sbstjn/cfn-release-example","last_synced_at":"2025-02-23T20:45:31.795Z","repository":{"id":137670693,"uuid":"312285276","full_name":"sbstjn/cfn-release-example","owner":"sbstjn","description":"Continuous Integration and Deployment for CloudFormation Templates using AWS CDK and GitHub Actions.","archived":false,"fork":false,"pushed_at":"2020-11-16T18:52:03.000Z","size":598,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-05T14:31:15.929Z","etag":null,"topics":["actions","aws","cdk","cloudformation","example","github","tooling"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sbstjn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-12T13:29:21.000Z","updated_at":"2020-11-16T18:52:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"67f5316e-6179-455e-88db-5e8f06af21b3","html_url":"https://github.com/sbstjn/cfn-release-example","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fcfn-release-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fcfn-release-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fcfn-release-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fcfn-release-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbstjn","download_url":"https://codeload.github.com/sbstjn/cfn-release-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240378873,"owners_count":19792039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","aws","cdk","cloudformation","example","github","tooling"],"created_at":"2024-11-09T20:45:05.389Z","updated_at":"2025-02-23T20:45:31.762Z","avatar_url":"https://github.com/sbstjn.png","language":"TypeScript","readme":"# Publish CloudFormation Templates with CDK\n\n[![MIT License](https://badgen.now.sh/badge/License/MIT/purple?1)](https://github.com/sbstjn/cfn-release-example/blob/master/LICENSE.md)\n[![MIT License](https://badgen.net/github/release/sbstjn/cfn-release-example?1)](https://github.com/sbstjn/cfn-release-example/releases)\n\n\u003e 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.\n\nWhen 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.\n\n**tl;dr:** _Use the AWS CDK to build a static YAML file and deploy it to S3._\n\n## Workflow\n\nUse the the **CDK** to create a CloudFormation Stack.\n\n### Integration\n\nA [GitHub Action in `integration.yml`](.github/workflows/integration.yml) runs `cdk build` on every `push` event.\n\n### Release\n\nA [GitHub Action in `release.yml`](.github/workflows/release.yml) creates a **GitHub Release** for every `tag` matching `v0.1.0` pattern.\n\n### Deployment\n\nThe static **YAML** file is uploaded to the **GitHub Release** and your **S3 Bucket**.\n\n## Configuration\n\nYou need to set the following `secrets` for your repository:\n\n- `AWS_BUCKET_NAME`\n- `AWS_BUCKET_REGION`\n- `AWS_KEY_ID`\n- `AWS_SECRET_ACCESS_KEY`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbstjn%2Fcfn-release-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbstjn%2Fcfn-release-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbstjn%2Fcfn-release-example/lists"}