@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.184.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2acef1ee232b9f0e5d0f13ba6dece0822b1f8bf50b1bc3c665a254a3f17c2fcb |
|
MD5 | d62026ca73f08d4ab9b1deba17e3df8b |
|
BLAKE2b-256 | ba02eb6957f6d4670fef4b127629b3426cfa089f58dcfa912127b1d933b1ff08 |
Hashes for cdktf_github_actions-0.0.184-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d697df42b082e8ed2ec220db82f929b308b42e889b0c75e41cb7f1d507ab8e8 |
|
MD5 | 89b285703b7a8f42c888efb68829377a |
|
BLAKE2b-256 | 4b682c9d2c3a1d4b73a3cdccbe4f20700fd66153a482774b5b40cbf5c1b22770 |