Skip to content

Commit 36b33aa

Browse files
authored
docs(readme): add considerations for deploying with vercel (#49)
1 parent d6a319c commit 36b33aa

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Follow the instructions to register a new GitHub app.
2222

2323
The app is continuously deployed using [Vercel's GitHub app](https://github.com/apps/vercel).
2424

25+
### Considerations
26+
- Make sure you configure [the environment variables for your GitHub App](https://probot.github.io/docs/configuration/) in Vercel. You can read more about how to do it in [their docs](https://vercel.com/docs/concepts/projects/environment-variables).
27+
- Vercel [expects to find your lambda functions under `/api` folder]([url](https://vercel.com/docs/concepts/functions/serverless-functions#deploying-serverless-functions)). Make sure your functions are placed there and double check Vercel detected your Lambda Functions during the deployment process by checking the logs:
28+
29+
![image](https://user-images.githubusercontent.com/2574275/187179364-b0019f95-be41-462a-97d5-facf4de39095.png)
30+
2531
## How it works
2632

2733
The [api/github/webhooks/index.js](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.

0 commit comments

Comments
 (0)