Skip to content

Files

Latest commit

Jan 21, 2021
ea00b36 · Jan 21, 2021

History

History
This branch is 235 commits behind cloudcomponents/cdk-constructs:master.

cdk-github-webhook

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Aug 5, 2020
Jul 22, 2020
Jul 4, 2020
Dec 6, 2020
Jan 6, 2021
Jan 21, 2021

cloudcomponents Logo

@cloudcomponents/cdk-github-webhook

Build Status cdkdx typescript python

Create, update and delete github webhooks with your app deployment

Install

TypeScript/JavaScript:

npm i @cloudcomponents/cdk-github-webhook

Python:

pip install cloudcomponents.cdk-github-webhook

How to use

import { Construct, Stack, StackProps } from '@aws-cdk/core';
import { RestApi } from '@aws-cdk/aws-apigateway';
import { GithubWebhook } from '@cloudcomponents/cdk-github-webhook';

export class GithubWebhookStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const api = new RestApi(this, 'github-webhook');
    api.root.addMethod('POST');

    const githubApiToken = process.env.API_TOKEN as string;

    // @example https://github.com/cloudcomponents/cdk-constructs
    const githubRepoUrl = process.env.REPO_URL as string;

    // @see https://developer.github.com/v3/activity/events/types/
    const events = ['*'];

    new GithubWebhook(this, 'GithubWebhook', {
      githubApiToken,
      githubRepoUrl,
      payloadUrl: api.url,
      events,
      logLevel: 'debug',
    });
  }
}

API Reference

See API.md.

Example

See more complete examples.

License

MIT