riley-kohler
commented
5 days ago When creating our GitHub apps I wrote up this list of instructions that might help when adding this info to the docs.
To create the GitHub app:
- Go to organization settings -> developer settings -> github apps -> register new github app
- For homepage url use the github app readme: https://github.com/github-community-projects/private-mirrors#readme
- For callback url use: http://localhost:3000/api/auth/callback/github
- Set webhook url to: http://localhost:3000/api/webhooks and set a secret
- Add permissions to the GitHub app based on the default_permissions listed in the app.yml:
- Repository
- Actions - read & write
- Administration - read & write
- Contents - read & write
- Custom properties - read & write
- Metadata - read-only (is mandatory by default)
- Workflows - read & write
- Organization
- Administration - read-only
- Custom properties - admin
- Members - read-only
- Account
- Email addresses - read-only
- In "Subscribe to events" section check the following:
- Installation target
- Meta
- Branch protection rule
- Fork
- Public
- Push
- Repository
- Repository dispatch
- Workflow dispatch
- Workflow job
- Workflow run
Describe the bug
The docs should be more explicit about which permissions the app needs to run.
To Reproduce
Read the docs, attempt to follow them....
Expected behavior
You should be able to get things working
Screenshots
No response
Additional context
No response