GitHub

Give Appentic access to your repositories so it can build and deploy them, and optionally push fixes.

Appentic builds your web services from GitHub through the Appentic GitHub App. Its access is read-only unless you turn on code fixes for a web service.

Installing the app is separate from signing in with GitHub. You can sign in with Google and still install the app.

Install the app

You can start the install from either place:

  • On the new web service form, click Connect GitHub.
  • In User settings → Connected accounts, under Repository access, click Install next to GitHub App.

GitHub asks which account or organisation to install the app on, and whether it may access all repositories or only the ones you select. You can change the repository selection later in your GitHub settings.

When you come back to Appentic, Connected accounts shows the app as Installed. If the app is already installed on your GitHub account, Install connects it straight away.

In a shared workspace, Appentic builds through the owner's GitHub connection, so the owner must have given Appentic access to every repository the workspace deploys.

What the app is used for

  • Listing repositories on the new web service form.
  • Detecting the runtime from the repository's Dockerfile or its files.
  • Reading the commit being built.
  • Push events, so a push to a web service's branch deploys it when Auto-deploy is on. See Deploys.

Code fixes

Code fixes let Athena and your coding agents push a fix to a web service's repository, for example after they find the cause of an error in its logs. They are off for every repository until you turn them on, one web service at a time.

To turn them on:

  1. Open the web service's Settings.
  2. Turn on Code fixes.

Athena can also ask you to allow them when it has a fix ready.

What to know:

  • Only the workspace owner can turn them on, because fixes go through the owner's GitHub connection. Anyone who can change the service can turn them off.
  • GitHub must approve write access once. If your installation doesn't allow Appentic to change code yet, Connected accounts shows Approve on GitHub next to Code fixes. Approving covers every repository the app can access, but Appentic only writes to the ones whose service has Code fixes on.
  • A fix is a normal commit on the branch the service deploys, so it deploys like any other push, and you can see and revert it on GitHub. A branch that is protected against direct pushes gets the fix as a pull request instead, which deploys when you merge it.
  • Connected accounts lists the repositories that currently allow fixes.

A repository is missing

If a repository doesn't appear when you search on the new web service form, the app probably doesn't have access to it. Update the app's repository access in your GitHub settings, then search again.

Disconnect

In User settings → Connected accounts, click the unlink icon next to GitHub App and confirm. Your services keep running, but you can't deploy new changes or create services from GitHub until you connect again.

To remove Appentic's access on GitHub's side as well, uninstall the app from your GitHub account or organisation settings.