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.33.0.tar.gz (455.9 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.33.0.tar.gz.

File metadata

  • Download URL: cloudcomponents.cdk-github-webhook-1.33.0.tar.gz
  • Upload date:
  • Size: 455.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.2

File hashes

Hashes for cloudcomponents.cdk-github-webhook-1.33.0.tar.gz
Algorithm Hash digest
SHA256 8ae57f576653934406de9034fd7f15de658001451a9b54b5d7b09b899b6287be
MD5 e39720c28cfe675cfe8ce318d307db80
BLAKE2b-256 b1ddb1c9090c9f586be847f56ff39a69aa11d52be36f1963292d206cca40b6e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudcomponents.cdk_github_webhook-1.33.0-py3-none-any.whl
  • Upload date:
  • Size: 455.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.2

File hashes

Hashes for cloudcomponents.cdk_github_webhook-1.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 04b31e6143735017b152c8c5f27d8b18ebac35ea29f102c753696ac08d72a5ab
MD5 be9d49271f5a796d8243843ac3126024
BLAKE2b-256 dfd4e5e40663692db470464eb771b181388c073554ab336905f3a5cc9ffc5806

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