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.44.0.tar.gz (533.2 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.44.0.tar.gz.

File metadata

  • Download URL: cloudcomponents.cdk-github-webhook-1.44.0.tar.gz
  • Upload date:
  • Size: 533.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.6

File hashes

Hashes for cloudcomponents.cdk-github-webhook-1.44.0.tar.gz
Algorithm Hash digest
SHA256 bf80689f9079e89b35d22bd28e176efd14e9225c2b038b3a948b3018740beef6
MD5 4d9c2a06e944e69243f3d65f1695deb6
BLAKE2b-256 ca18e47340a0b941b19d8e6421a958cf765ed02b9d3061ace7fc0f345022a6c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudcomponents.cdk_github_webhook-1.44.0-py3-none-any.whl
  • Upload date:
  • Size: 532.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.6

File hashes

Hashes for cloudcomponents.cdk_github_webhook-1.44.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9fa9dd58ed2095890210da150bca756e29058c67e2fbb7f2e2ba15ea3779ba9
MD5 83a49c0cd9f8fd7b176b4fb4a4a1ced2
BLAKE2b-256 8c936ad50e85a70aa140d6ebe0cd160abf34c27e4568c80fcecf17463b448073

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