GitHub Auto-Deploy
Connect a GitHub repository and your app deploys itself every time you push.
Connect your repository
- Open your app and go to the GitHub tab
- Enter your repository URL, for example
https://github.com/username/repo - Choose the branch to deploy from (usually
main) - Turn on Auto-deploy on push
- 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 → liveFor 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
- Go to the Deploys tab
- Open the most recent deployment
- 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/repoform - Confirm the branch name matches your repository exactly (
mainandmasterare 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