Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add relation between webhook events and permissions #8

Open
gr2m opened this issue Aug 26, 2020 · 1 comment
Open

Add relation between webhook events and permissions #8

gr2m opened this issue Aug 26, 2020 · 1 comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request

Comments

@gr2m
Copy link
Contributor

gr2m commented Aug 26, 2020

What’s missing?

An app can only subscribe to events based on the permissions it requested. For example, an app will not receive push events if it does not at least have read access for the contents permission.

I am not sure if that relation is documented anywhere though. What we could do is maintain this list manually. When creating / updating a GitHub App registration, the events show up at the bottom of the Options page when enabling / disabling permissions. We could write a script that we can just run in the browser to toggle the permissions one-by-one and read out the events that are displayed. Then at the end spit out a JSON object that we can paste back into our code base.

Why?

See probot/probot#1317. We could validate the app.yml file locally, without relying on GitHub's server response, and provide a error message / user experience.

Alternatives you tried

@gr2m gr2m added Type: Feature New feature or request Status: Up for grabs Issues that are ready to be worked on by anyone labels Aug 26, 2020
@wolfy1339
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants