Client Area

GitHub Auto-Deploy

2 min readPublished 6 Apr 2026Updated 22 Aug 2026343 views

In this article

  • 1Connect your repository
  • 2What happens on each push
  • 3Watching a deploy
  • 4Deploying without pushing
  • 5Turning it off

GitHub Auto-Deploy

Connect a GitHub repository and your app deploys itself every time you push.

Connect your repository

  1. Open your app and go to the GitHub tab
  2. Enter your repository URL, for example https://github.com/username/repo
  3. Choose the branch to deploy from (usually main)
  4. Turn on Auto-deploy on push
  5. Click Connect Repository

A public repository needs nothing further. For a private repository you will need to grant access when prompted.

What happens on each push

You push to GitHub → we receive the change → your code is pulled → built → health-checked → live

For most apps this takes under a minute, and traffic only moves to the new version once it passes its health check. If a build fails, your current version keeps running.

Watching a deploy

  1. Go to the Deploys tab
  2. Open the most recent deployment
  3. Read the build output

If a deploy fails, the log here is the first place to look.

Deploying without pushing

Use Deploy Now in the GitHub tab to rebuild from the current branch without making a commit.

Turning it off

Click Disconnect in the GitHub tab. Your app keeps running exactly as it is — it simply stops deploying on push. You can reconnect at any time.

Deploying from your terminal instead

If you would rather not connect GitHub, use a deploy token — see Deploying with a Deploy Token. Both methods can be used on the same app.

If a connection does not seem to save

  • Check the repository URL is the full https://github.com/user/repo form
  • Confirm the branch name matches your repository exactly (main and master are different)
  • For a private repository, make sure access was granted
  • If it still does not connect, open a ticket with your app name and the repository URL

Was this article helpful?

Your feedback helps us improve our documentation

Still need help? Submit a support ticket

GitHub Auto-Deploy - Knowledge Base