Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.27 KB

README.md

File metadata and controls

35 lines (22 loc) · 1.27 KB
Raw

Blitz.js GitHub Bot

Bot to manage Blitz GitHub project board, all-contributors list in README, and other automations!

It runs on Vercel.

Setup

# Install dependencies
yarn

# Run locally
./scripts/run-dev.sh [smee-url]

Environment Variables

  • WEBHOOK_SECRET: a random string of characters. Could be anything
  • PERSONAL_ACCESS_TOKEN: a Personal Access Token of the account that will do all the interaction. More info.
  • LOG_LEVEL (optional): log4js level. More info here (look for level)

Developing locally

When developing locally, you need to get a new Smee URL and set the Webhook URL to that Smee URL. Then, save your env vars in .env, next to .env.example. Finally, execute this to run your app (make sure to have the Vercel CLI installed):

./scripts/run-dev.sh [your-smee-url]

Adding a new event

If you are adding a Organization event, rembember to add it to the organization webhook.

If you are adding a Repository event, rembember to add it to the each repository and in this events array.