@awlsring/cdktf-github-actions
Project description
cdktf-github-actions
This is a library to help define GitHub Actions workflows using CDKTF. This package vends constructs for defining a workflow that will be synthesized to a workflow yaml file in your repos .github/workflows
directory.
Development
This project is in early development. The constructs are likely to change as the needs of the project evolve.
A few items I'm currently working towards:
- More github resource synthesis
- Higher test coverage
- More indepth documentation
Usage
Example
import { Construct } from 'constructs';
import { App, TerraformStack } from 'cdktf';
import { Workflow, Job } from 'cdktf-github-actions';
const app = new App();
class MyWorkflowStack executes TerraformStack {
constructor(scope: Construct, name: string) {
super(scope, name);
let echoJob = new Job(this, 'build-job', {
steps: [
{
name: 'echo',
run: 'echo "Hello World"',
},
],
});
const wf = new Workflow(this, 'workflow', {
repoName: 'my-repo',
jobs: [echoJob],
});
}
}
const stack = new MyWorkflowStack(app, 'test');
app.synth();
The constructs support the ability to define github resources and create them using the github terrafrom provider. The following example shows how to create a create a workflow with secrets that will be stored in the repository.
import { Construct } from 'constructs';
import { App, TerraformStack } from 'cdktf';
import { Workflow, Job } from 'cdktf-github-actions';
const app = new App();
class MyWorkflowStack executes TerraformStack {
constructor(scope: Construct, name: string) {
super(scope, name);
let echoJob = new Job(this, 'build-job', {
steps: [
{
name: 'echo',
run: 'echo "Hello World"',
withSecrets: [
{
referencedName: 'token',
secretName: 'MY_SECRET',
secretValue: '123',
},
],
},
],
});
const wf = new Workflow(this, 'workflow', {
repoName: 'my-repo',
jobs: [echoJob],
});
}
}
const stack = new MyWorkflowStack(app, 'test');
app.synth();
The example above will create a secret with the name MY_SECRET
and the value 123
in the repository. The secret will be referenced in the workflow using the name token
.
Project details
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 cdktf-github-actions-0.0.260.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 523a938a00c3c3af1f5b0155dac69210c9d80d4182d95622713a38656b3bff2e |
|
MD5 | 72941d0c04c1a793efa3b3de9367f330 |
|
BLAKE2b-256 | d916b3621b1243364ddbd9da36738d0485f40f5a7a9fe0d6b18decd7f2250a23 |
Hashes for cdktf_github_actions-0.0.260-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e12ad234e29e2e95e53b27547b0ba1c0f17be50d1466f0e50c8192ebab3d207f |
|
MD5 | 657dfc24fb3ae5ab26b3c61788b9d235 |
|
BLAKE2b-256 | 9c5af049d8b00a83d010ad6830b66b452010f3326bf5ba8438bcb1931be633aa |