greggbjensen/prdeploy-webhooks repository overview

⁠prdeploy-webhooks

The prdeploy API has webhooks to allow GitHub to pass events, as well as the GraphQL API for displaying the web page.

• For local development the GitHub App Webhook must be configured to receive events at a URL that is accessible from the internet using smee⁠.

⁠Development

1. Download the private key from the your organizations GitHub App page and rename to gh_app_key.pem in this root folder.
2. Create a .env file similar to .env.example and set actual values.
3. Install dependencies with npm install.
4. Start webhook proxy with npm run webhook.
5. Start the server with npm start.

⁠Debugging

1. Open this repository root with VS Code.
2. Set a breakpoint in the App.
3. Click on the Debug icon on the left nav.
4. Select prdeploy-webhooks from the RUN AND DEBUG drop down.
5. Click the Start Debugging icon.

⁠Deployment

1. Each pull request should be deployed as ready in the CD workflow.
2. Only once deployed and verified the pull request should be merged to main.
3. This application is deployed to a kubernetes cluster using the helm chart.

⁠Usage

With your server running, you can now create a pull request on any repository that your app can access. GitHub will emit a pull_request.opened event and will deliver the corresponding Webhook payload⁠ to your server.

The server in this example listens for pull_request.opened events and acts on them by creating a comment on the pull request, with the message in message.md, using the octokit.js rest methods⁠.

⁠Testing

Before you check in code, make sure to run npm run checks to verify everything is building, linting, and tested properly.

⁠Security considerations

To keep things simple, this example reads the GITHUB_APP_PRIVATE_KEY from the environment. A more secure and recommended approach is to use a secrets management system like Vault⁠, or one offered by major cloud providers: AWS Secrets Manager⁠,