Deploying from GitHub

By the StarDomain teamPublished 2 min read
Knowledge base article
Contents (5 sections)

Connect a GitHub repository to your app, then deploy it with one click whenever you are ready.

Automatic deploy on every push is not available at the moment. Pushing to GitHub does not start a deploy by itself. Click Deploy Now after you push, or deploy from your CI with a deploy token (below). That gives you deploy-on-push today, from GitHub Actions, GitLab CI or Bitbucket Pipelines.

Connect your repository

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

A public repository needs nothing further. For a private repository, also paste a GitHub personal access token with repo scope in the Access token field. It is stored encrypted and never shown again; you can replace or remove it from the same tab.

Deploying

Click Deploy Now. We pull the branch you chose, build it and start it. If a build fails, the version that was already running keeps running.

Deploy on every push, using your CI

  1. Create a token under Access › Deploy Tokens
  2. Add it to your CI as a secret
  3. Copy the ready-made GitHub Actions, GitLab CI or Bitbucket Pipelines example from the same tab

Your CI then uploads your code on each push and the app deploys.

Build logs

Open the Deploy section of your app to see each deployment and its build output. If a deploy fails, the log is the first place to look.

Disconnecting

Click Disconnect in the GitHub tab. Your app keeps running exactly as it is.

Was this article helpful?

Your answer helps us decide what to improve next.

Still need help? Open a support ticket and our team will reply.

Prefer an app? Add this site to your home screen.Get the app
Deploying from GitHub - Knowledge Base