README.md

cdk-aws-codebuild-github-runners

CDK app that, given an existing GitHub repository, attaches a repository webhook that triggers self-hosted runners in AWS CodeBuild when workflow jobs are queued.

Related Apps

• cdktf-aws-codebuild-github-runners - Built with CDKTF instead of AWS CDK.
• cdktf-aws-codebuild-github-runners-organization - Built with CDKTF instead of AWS CDK; uses a GitHub organization webhook instead of repository webhook.

Prerequisites

• AWS:
  • Must have authenticated with Default Credentials in your local environment.
  • Must have completed the CDK bootstrapping for the target AWS environment.
• GitHub:
  • Must have created a GitHub repository in your personal account.
  • Must have set the GITHUB_TOKEN, GITHUB_OWNER and GITHUB_REPO variables in your local environment.
• Node.js + npm:
  • Must be installed in your system.

Installation

npx projen install

Deployment

npx projen deploy

Usage

1. Navigate to https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/actions/workflows/hello-world.yml.

2. Click Run workflow ➜ Run workflow.

3. Your workflow will be enqueued and run on an ephemeral EC2 instance managed by AWS CodeBuild.

Cleanup

npx projen destroy

Architecture Diagram