Getting started · 2 of 6
Connect GitHub, read-only.
Propel reads GitHub through an app that can only read: your code, docs and changelog. Docs pull requests come later, through a second app that can open them and never merges.
Opening soon Propel isn't open for sign-up yet. This guide shows how it works on day one. Join the waitlist to get in first.
Why connect it?
So Propel knows what you built from the source, not only from your website. It reads your README, docs and changelog and keeps each fact with its file, so a release can become a launch. Noticing new work on your main branch on its own comes later, with Always on.
What can the app see and do?
| App | Permissions | What it does |
|---|---|---|
| Propel (reader) | Read contents, read metadata | Reads your code and docs. Its access token lasts an hour and is never stored. |
| Propel pull requests (later) | Write contents and pull requests | Later: opens a pull request with a docs change. It cannot merge one: you do. |
How do you connect it?
- In Propel, choose to connect GitHub.
- GitHub shows the app and its read-only permissions. Choose the repositories it may read.
You can remove the app from your GitHub settings at any time.