docs: clarify required GitHub App permissions and webhook events#742
Open
foxted wants to merge 1 commit intovercel-labs:mainfrom
Open
docs: clarify required GitHub App permissions and webhook events#742foxted wants to merge 1 commit intovercel-labs:mainfrom
foxted wants to merge 1 commit intovercel-labs:mainfrom
Conversation
|
@foxted is attempting to deploy a commit to the Vercel Labs Team on Vercel. A member of the Team first needs to authorize it. |
|
plans to merge it soon? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document GitHub App permissions and webhook subscriptions in
README.mdso setup is clearer and less error-prone.Changes
README.md.apps/webusage:Members: read)./api/github/webhookGITHUB_WEBHOOK_SECRETinstallation,installation_repositories,pull_requestWhy
The previous README documented env vars and callback URLs, but it did not clearly specify GitHub App permission scopes and webhook subscriptions. This made setup ambiguous and could cause avoidable integration failures.
Note
These permissions were derived by exploring the current codebase and inferring required API access from the GitHub endpoints used. This is a best-effort starting point, not a guaranteed exhaustive or future-proof list.