AWS CDK Construct Library to interact with GitHub's API.
Project description
CDK-GitHub
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).
🔧 Installation
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
📚 Constructs
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.
🔓 Authentication
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.
👩🏫 Examples
The API documentation and examples in different languages are available on Construct Hub. All (typescript) examples can be found in the folder examples.
ActionSecret
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,
});
}
}
ActionEnvironmentSecret
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,
});
}
}
GitHubResource
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,
});
}
}
💖 Contributing
Contributions of all kinds are welcome! Check out our contributing guide.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk_github-0.0.54-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 63f64ee87dfcfca13b8dc0dbc12e2bb262ed78eae24be52a71f90ed8bf467d40 |
|
| MD5 | 7f53adc3b35f5b09beb87dc03b1a741a |
|
| BLAKE2b-256 | 3ff541807ebd8658981239b340c285502a550f456b3e79f58ff66e396ff13b44 |
