Keep an app in GitHub

An app made in the App Builder lives in Sovaria, with its own version history. Connect it to a repository and that folder becomes its home in GitHub too: your team reviews it there, CI runs on it, and changes made in GitHub can come back into the app.

#Connect a repository

1. 1

   Connect GitHub once

   Sovaria uses your own GitHub connection (Functions › GitHub). It needs push access to the repository. Your GitHub access stays with Sovaria's servers: it is never sent to the browser or to the app.

2. 2

   Open the app's settings

   In the app studio, open Settings › GitHub and enter the repository (owner/name), the branch and, if the app is one folder of a bigger repository, that folder (for example web).

3. 3

   Choose when to push

   Turn on Push on every publish to send each published version to GitHub (paid plans). Without it, push whenever you like with Push to GitHub.

If the folder already has code, Sovaria asks first: connecting means the app's files replace that folder's source files on the next push. To start from that code instead, import the repository as a new app (Apps › New › Import from GitHub).

#What a push does

Each push is one commit on top of the branch, never a force-push. If someone committed to the branch outside Sovaria since the app last matched it, the push stops and says so (GITHUB_BRANCH_MOVED): Pull from GitHub first to bring their changes in, open a pull request instead, or choose Push anyway — their commits stay in the history, but where both changed the same file the app's version wins. Pushing a version GitHub already has does nothing.

#Push on every publish

With Push on every publish on, each live publish of the app also pushes the published version, with the publishing person's GitHub access. A push that fails (for example, the branch moved) never undoes the publish: Publish reports it, and Settings › GitHub shows the last successful push.

#Pull changes back

Pull from GitHub reads the folder on the branch and saves its source files as a new version of the app. Earlier versions stay in the app's history, so a pull can be undone with Restore. Open a pull request puts the app's current files on a new branch and opens a pull request into the connected branch, for review before they land.

#From the API

PUT    /api/v1/fn/hosting/frontends/{id}/github       {repository, branch, root, push_on_publish, replace_existing?}
POST   /api/v1/fn/hosting/frontends/{id}/github/push  {message?, force?}
POST   /api/v1/fn/hosting/frontends/{id}/resync       pull the folder back as a new version
POST   /api/v1/fn/hosting/frontends/{id}/pull-request {title, body?}
DELETE /api/v1/fn/hosting/frontends/{id}/github       disconnect (nothing in GitHub changes)