Skip to main content

@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

cdktf-github-actions-0.0.11.tar.gz (211.7 kB view details)

Uploaded Source

Built Distribution

cdktf_github_actions-0.0.11-py3-none-any.whl (210.5 kB view details)

Uploaded Python 3

File details

Details for the file cdktf-github-actions-0.0.11.tar.gz.

File metadata

  • Download URL: cdktf-github-actions-0.0.11.tar.gz
  • Upload date:
  • Size: 211.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for cdktf-github-actions-0.0.11.tar.gz
Algorithm Hash digest
SHA256 06dc16d5ef3053bbd4920ce3132fd365c855effcbcf8cca7c245eb754c9d2e1f
MD5 4d8df424b9e9298c6ac7cc2254332730
BLAKE2b-256 f5c81b248e07c340aa9570205307292cf4fa36929a4f80b40a2cddef810cdfc3

See more details on using hashes here.

File details

Details for the file cdktf_github_actions-0.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for cdktf_github_actions-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 4e06d1502e3f1bfdf3a7693aea7372c62273be9a8933729a5d45dcbaced11868
MD5 6382bd8415f85d2f1ac86aebe3dcd837
BLAKE2b-256 008f2bb6961628a4ea967099c0ec46604e4d449a3bc5a8ffeb1854422d15ed60

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page