DEVELOPMENT.md

Development

Resources

• PR Code Reviewer (GitHub App)
• GitHub App client docs
• GitHub API client docs
• Webhook events and payloads

Prerequisites

• Volta (a lightweight zero-config tool manager, installation)

Setup

Install dependencies

yarn

Environment variables

Create a .env file in the root of the project

cp .dev.vars.dist .dev.vars

Now fill the .dev.vars file with the correct values.

Develop

yarn dev

Then fire specific http requests from the triggers folder.

Test

yarn coverage

Updating secrets

Local

Update the .dev.vars file

Production

Run the following command, which will prompt you for a value.

yarn wrangler secret put NAME_OF_MY_SECRET

Note: In case of the private key, be sure to preserve the newlines.

Deploy

yarn deploy

Upgrading tools

Upgrade Node

volta pin node@lts

Upgrade Yarn

yarn set version stable
volta pin yarn