Skip to main content

Create, update and delete github webhooks with your app deployment

Project description

cloudcomponents Logo

@cloudcomponents/cdk-github-webhook

Build Status cdkdx typescript python Mentioned in Awesome CDK

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

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_cdk.aws_apigateway import RestApi
from aws_cdk.core import Construct, Stack, StackProps
from cloudcomponents.cdk_github_webhook import GithubWebhook
from cloudcomponents.cdk_secret_key import SecretKey

class GithubWebhookStack(Stack):
    def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None, analyticsReporting=None):
        super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection, analyticsReporting=analyticsReporting)

        api = RestApi(self, "github-webhook")
        api.root.add_method("POST")

        github_api_token = SecretKey.from_plain_text(process.env.API_TOKEN)

        # @example https://github.com/cloudcomponents/cdk-constructs
        github_repo_url = process.env.REPO_URL

        # @see https://developer.github.com/v3/activity/events/types/
        events = ["*"]

        GithubWebhook(self, "GithubWebhook",
            github_api_token=github_api_token,
            github_repo_url=github_repo_url,
            payload_url=api.url,
            events=events,
            log_level="debug"
        )

API Reference

See API.md.

Example

See more complete examples.

License

MIT

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

cloudcomponents.cdk-github-webhook-1.30.0.tar.gz (454.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file cloudcomponents.cdk-github-webhook-1.30.0.tar.gz.

File metadata

  • Download URL: cloudcomponents.cdk-github-webhook-1.30.0.tar.gz
  • Upload date:
  • Size: 454.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.2

File hashes

Hashes for cloudcomponents.cdk-github-webhook-1.30.0.tar.gz
Algorithm Hash digest
SHA256 62eb1c28084d51a942fc08c73815c97ce31d17bbf198a547a62eab78b71f75a0
MD5 e57ea16d7cb6425de39d715e899ea0c7
BLAKE2b-256 a44306f3f69b531c64fd72c180b38219798620137f9b1a1fda2f3deb271f3789

See more details on using hashes here.

File details

Details for the file cloudcomponents.cdk_github_webhook-1.30.0-py3-none-any.whl.

File metadata

  • Download URL: cloudcomponents.cdk_github_webhook-1.30.0-py3-none-any.whl
  • Upload date:
  • Size: 454.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.2

File hashes

Hashes for cloudcomponents.cdk_github_webhook-1.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c47fe5aca24f03b3dbd06284322263500722b4f59b58a216d40aeae59af4aac6
MD5 7706f1a648046d06611b2b516ccefa73
BLAKE2b-256 e8736a21efdc1ee3368c160e4272bf8e594dad545ae3afe2334512a862546f12

See more details on using hashes here.

Supported by

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