Skip to content

oscard0m/example-probot-vercel-ts

Repository files navigation

Probot & Vercel example

This repository is an example of how to deploy the "Hello, World" of probot apps to Vercel.

Local setup

Install dependencies

npm install

Build the project

npm run build

Start the server

npm start

Follow the instructions to register a new GitHub app.

Deployment

The app is continuously deployed using Vercel's GitHub app.

Considerations

  • Make sure you configure the environment variables for your GitHub App in Vercel. You can read more about how to do it in their docs.
  • Vercel expects to find your lambda functions under /api folder. Make sure your functions are placed there and double check Vercel detected your Lambda Functions during the deployment process by checking the logs:

image

How it works

The api/github/webhooks/index.js file is handling requests to POST /api/github/webhooks, make sure to configure your GitHub App registration's webhook URL accordingly.

License

ISC