Connect GitHub
Shiplon builds apps from GitHub repositories through the Shiplon GitHub App. Each organization in Shiplon connects to one GitHub account or GitHub organization.
Connect
Section titled “Connect”-
In the sidebar, open Integrations → GitHub and click Connect GitHub. You need to be an owner or admin of the Shiplon organization.
-
On GitHub, choose the account or GitHub organization that owns your repositories. To install on a GitHub organization, you need to be an owner of it there, or ask one to approve the request.
-
Choose All repositories, or Only select repositories and pick them.
-
GitHub sends you back to Shiplon. The page shows the connected account, the repositories Shiplon can see, and recent events from GitHub.
What Shiplon can access
Section titled “What Shiplon can access”The app asks GitHub for the least it needs:
| Permission | Why |
|---|---|
| Contents: read-only | To fetch the commit being deployed, list branches, and look at your files to suggest a build type. |
| Metadata: read-only | Required by GitHub for every app: repository names and visibility. |
| Push events | So a push to an app’s branch can start a deployment. |
Shiplon can’t push code, change settings, read issues or pull requests, or see repositories you haven’t selected. Each build gets a short-lived token for only the repository being built.
Add or remove repositories
Section titled “Add or remove repositories”On Integrations → GitHub, click Change repository access on GitHub. Changes show up in Shiplon straight away.
If you remove a repository that an app deploys from, the app keeps running, but new deployments of it fail until access is given back.
Renames and transfers
Section titled “Renames and transfers”Shiplon tracks repositories by their permanent GitHub ID. If you rename a repository, or rename your GitHub account or organization, the app follows the new name by itself. The change is recorded in the activity log.
Suspended or disconnected
Section titled “Suspended or disconnected”- Suspended on GitHub: someone suspended the app in GitHub’s settings. Shiplon can’t see repositories or deploy until it’s unsuspended there.
- Disconnect GitHub…: removes the link between this Shiplon organization and GitHub. Running apps keep running, but nothing can deploy until you connect again. The app also stays installed on GitHub: to remove it completely, uninstall it in GitHub under Settings → Applications for your account, or the organization’s Settings → GitHub Apps.
Private repositories
Section titled “Private repositories”Private repositories work the same as public ones. Shiplon only reads them with the access you granted, and the code is used only to build your app.