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.46.0.tar.gz (543.5 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.46.0.tar.gz.

File metadata

  • Download URL: cloudcomponents.cdk-github-webhook-1.46.0.tar.gz
  • Upload date:
  • Size: 543.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cloudcomponents.cdk-github-webhook-1.46.0.tar.gz
Algorithm Hash digest
SHA256 d63e0d1ebed6ae078927a664b43a4456f7a48987f15bef8589520e651a21e3b7
MD5 23dc2c72257cc2b697dcd6955bd13e97
BLAKE2b-256 256510f0e878c8a9fe1181762756ebdb143b562eff3ade6b2b122905d66c2aa2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudcomponents.cdk_github_webhook-1.46.0-py3-none-any.whl
  • Upload date:
  • Size: 542.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cloudcomponents.cdk_github_webhook-1.46.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b87c7721c5107b547c3db3976e83e276de4f29049a2b73f17139d9143a8473c
MD5 84e45e86e37600bfcac37561d28c1b3d
BLAKE2b-256 2c1eb7bea9273490fb7fb2fd7ced73a5b481735f632231b9f65bea3801f175e6

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