GitHub Constructs for use in AWS CDK .
This project aims to make GitHub's API accessible through CDK with various helper constructs to create resources in GitHub.
The target is to replicate most of the functionality of the official Terraform GitHub Provider.
Internally AWS CloudFormation custom resources and octokit are used to manage GitHub resources (such as Secrets).
JavaScript/TypeScript:
npm install cdk-github
Python:
pip install cdk-github
Java
Maven:
<dependency>
<groupId>io.github.wtfjoke</groupId>
<artifactId>cdk-github</artifactId>
<version>VERSION</version>
</dependency>Gradle:
implementation 'io.github.wtfjoke:cdk-github:VERSION'
Gradle (Kotlin):
implementation("io.github.wtfjoke:cdk-github:VERSION")
C#
See https://www.nuget.org/packages/CdkGithub
This library provides the following constructs:
- ActionEnvironmentSecret - Creates a GitHub Action environment secret from a given AWS Secrets Manager secret.
- ActionSecret - Creates a GitHub Action (repository) secret from a given AWS Secrets Manager secret.
- GitHubResource - Creates an arbitrary GitHub resource. When no suitable construct fits your needs, this construct can be used to create most GitHub resources. It is an L1 construct.
Currently the constructs only support authentication via a GitHub Personal Access Token. The token needs to be a stored in a AWS SecretsManager Secret and passed to the construct as parameter.
The API documentation and examples in different languages are available on Construct Hub.
All (typescript) examples can be found in the folder examples.
import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
import { ActionSecret } from 'cdk-github';
export class ActionSecretStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const githubTokenSecret = Secret.fromSecretNameV2(this, 'ghSecret', 'GITHUB_TOKEN');
const sourceSecret = Secret.fromSecretNameV2(this, 'secretToStoreInGitHub', 'testcdkgithub');
new ActionSecret(this, 'GitHubActionSecret', {
githubTokenSecret,
repository: { name: 'cdk-github', owner: 'wtfjoke' },
repositorySecretName: 'A_RANDOM_GITHUB_SECRET',
sourceSecret,
});
}
}import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
import { ActionEnvironmentSecret } from 'cdk-github';
export class ActionEnvironmentSecretStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const githubTokenSecret = Secret.fromSecretNameV2(this, 'ghSecret', 'GITHUB_TOKEN');
const sourceSecret = Secret.fromSecretNameV2(this, 'secretToStoreInGitHub', 'testcdkgithub');
new ActionEnvironmentSecret(this, 'GitHubActionEnvironmentSecret', {
githubTokenSecret,
environment: 'dev',
repository: { name: 'cdk-github', owner: 'wtfjoke' },
repositorySecretName: 'A_RANDOM_GITHUB_SECRET',
sourceSecret,
});
}
}import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
import { StringParameter } from 'aws-cdk-lib/aws-ssm';
import { GitHubResource } from 'cdk-github';
export class GitHubResourceIssueStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const githubTokenSecret = Secret.fromSecretNameV2(this, 'ghSecret', 'GITHUB_TOKEN');
// optional
const writeResponseToSSMParameter = StringParameter.fromSecureStringParameterAttributes(this, 'responseBody', { parameterName: '/cdk-github/encrypted-response' });
new GitHubResource(this, 'GitHubIssue', {
githubTokenSecret,
createRequestEndpoint: 'POST /repos/WtfJoke/dummytest/issues',
createRequestPayload: JSON.stringify({ title: 'Testing cdk-github', body: "I'm opening an issue by using aws cdk 🎉", labels: ['bug'] }),
createRequestResultParameter: 'number',
deleteRequestEndpoint: 'PATCH /repos/WtfJoke/dummytest/issues/:number',
deleteRequestPayload: JSON.stringify({ state: 'closed' }),
writeResponseToSSMParameter,
});
}
}Contributions of all kinds are welcome! Check out our contributing guide.
