Deploy from GitHub

A GitHub connection keeps GitHub as the source of truth while Tokay follows the selected branch and prepares each new commit. The Project's auto-deploy setting decides whether the update deploys automatically or waits for you.

Last updated

AI agent? Start with llms.txt.

Connect the repository

  1. From Add code, choose GitHub.
  2. Authorize Tokay. Install the GitHub App for durable team access, or use personal GitHub access when you cannot install apps on the repository.
  3. Choose the repository, or enter owner/repo if it is not listed.
  4. Choose a branch. Tokay synchronizes it and detects the Services it can run.
  5. Review the detected setup and deploy the Service you want.

Each Service follows its selected branch. Change it in Service Settings between builds and deployments; the running app stays up. Commits to branches no Service follows do not deploy.

GitHub stays in control of the code

Continue editing locally or on GitHub, or use Tokay’s source editor to create a pull request. The PR targets the selected branch and must be merged on GitHub before it deploys.

Tokay caches the default and selected branches for builds and deployment. A clone of that cache is not a full copy of every upstream branch and tag. Deploying needs only read access. To open pull requests from Tokay, enable pull requests for the repository or use a GitHub account that can push to it. GitHub notifies Tokay when a commit arrives, and Tokay also checks for updates so a missed notification delays a deploy rather than losing it.

Disconnect without taking the app down

Disconnecting stops the GitHub relationship but does not stop the running Services. Tokay keeps the code it already has as hosted code, and the repository on GitHub is unchanged.

See Editing your code for the shared commit and pull-request workflow.