GitHub connects as a GitHub App. You click, approve on GitHub, and Deplo receives the credentials. There is no client id or private key to copy. The App is installed on the accounts and organisations that hold your repositories, and creates short-lived tokens to list and clone them.
Connect it
Start the connection
Settings -> Git, then Connect.
Choose account or organization
Choose Personal account or Connect an organization.
Approve and pick repositories
Approve on GitHub and pick which repositories the App may see.
Manage takes you back to GitHub to change that selection later.
What the App needs
A new App already has all of this. It matters only if someone narrows the App later on GitHub:
| On GitHub | What it unlocks |
|---|---|
| Metadata: Read-only | See your repositories |
| Contents: Read-only | Clone your code to build it |
| Subscribe to event: Push | Deploy automatically when you push |
| Pull requests: Read and write | Post the preview address on the pull request |
| Subscribe to event: Pull request | Build a preview when a pull request opens |
The last two are only needed for pull request previews.
When something is missing, Deplo shows Deplo is missing access on GitHub with the exact list, on Settings -> Git, on the app's Deploy source settings and on its Pull requests page. Update on GitHub opens the App's permissions page.
When the App's permissions change, GitHub keeps them pending until someone accepts them on each installation. Approve there too, or Deplo keeps reporting them as missing.
Troubleshooting
- The repository list is empty: the GitHub App has no access. Use Manage and grant it there.
Authentication failedin a clone: the token expired or was revoked. Test connection confirms it.- "Deplo is missing access on GitHub": the App no longer has everything in the table above. Click Update on GitHub.
- "This repository will not clone": the repository is not in the App's selection. Use Manage and add it.
Next steps
Did this page help you?