GitHub
Connect Deplo as a GitHub App, through GitHub's own manifest flow.
GitHub connects as a GitHub App, created through GitHub's manifest flow: you click, you approve on GitHub, and Deplo receives the credentials directly. There is no client id or private key to copy. The App is installed on the accounts and organisations that hold your repositories, and mints 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
The manifest flow asks GitHub for exactly this, so a freshly connected App already has it. It matters when someone narrows the App later on GitHub:
| On GitHub | What it unlocks |
|---|---|
| Metadata: Read-only | See your repositories at all |
| 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, and Deplo only mentions them once a team uses them.
Deplo asks GitHub what the App is allowed to do and 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, the only place GitHub lets you change them.
GitHub emails the App's owner when its permissions change, and the new ones stay pending until someone accepts them on each installation. Approve there too, or Deplo keeps reporting them as missing.
If it does not work
- 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. Update on GitHub takes you straight to its permissions page.
- "This repository will not clone": the App is fine, but this repository is not in its selection. Use Manage and add it.
See also
Did this page help you?