GitHub
What Paperbeam reads from GitHub, the read-only access it asks for and why, filters, and the beats it feeds.
Product & engineering
Read-only OAuth
Merged pull requests and published releases from the repositories you choose.
What we read
- Pull requests merged in the window in the repositories you choose.
- Releases published in the window, with release notes.
Only the reporting window of each edition is read. Paperbeam stores derived facts and short excerpts, not copies of your GitHub data, and keeps raw evidence only for your retention period.
Access we ask for, and why
| Scope | Why |
|---|---|
pull_requests:read | Read merged pull requests |
contents:read | Read releases and tags |
metadata:read | List repositories so you can choose them |
All access is read-only. You can revoke it from GitHub at any time, or disconnect the source in Paperbeam.
Connect GitHub
- Go to Sources and choose GitHub.
- Click Continue to GitHub and approve the read-only access in the window that opens.
- The credential is encrypted before it is stored and never shown again. Use Sync now on the source’s page to see what it collects from the last 24 hours, and set filters there.
You need the admin or owner role in Paperbeam, and enough permission in GitHub to grant read access to the data listed above.
Filters
Set on the source’s page at Sources›GitHub. Filtered-out data is never collected.
| Filter | Effect |
|---|---|
| Repositories | Required. The owner/repo repositories to read. Nothing is read until you pick at least one. |
| Pull requests | Turn off to read releases only. |
To keep specific people, channels or topics out of the paper across all sources, use exclusion rules and the never-mention list in House style.
Beats
GitHub is a source for:
Stories land in whichever of your sections fits them best.