@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.296.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01ba1dceb6b4be4027fbc32487a9da02c676f61aa9c5df0d0641713fb9e22096 |
|
MD5 | 2b2a62fb62de735969ba4423dcf3de50 |
|
BLAKE2b-256 | 5ae9832406b0f218ef2bd020fae9cca75f195327dc524f09ce33c999f2ce50a5 |
Hashes for cdktf_github_actions-0.0.296-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d2699b90c54c565d00d3d103deca877bb8b12bbf473f7591e1f077d1970b1a6 |
|
MD5 | 52a254dc166f6ab50aea3cb8e7bcf755 |
|
BLAKE2b-256 | 8917de3ef8ee2708d00efb63b1d224b7fd41c866f4048f5e8622a2268325c00d |