Skip to content

GitHub push-to-deploy

Connect your theme’s GitHub repository to a storefront site and every push to the chosen branch deploys automatically: the platform downloads your commit, builds it server-side, and activates it — with the result reported right on the commit.

  1. In your Workspace, open Website → Settings and find the GitHub card.
  2. Install the Kotao Storefront Deploy GitHub App — on your own account or organization, and grant it the theme repository (private repositories work).
  3. Back in the settings card, pick the repository and branch to deploy from. If the theme lives in a subfolder of a bigger repository, set the subdirectory — the build starts there.

One repository + branch connects to one storefront site.

Terminal window
git commit -am "polish the hero"
git push

That’s the whole deploy. On every push to the connected branch:

  1. The platform verifies the webhook, queues the build, and reports a commit status (kotao/deploy) — pending while building.
  2. Your committed source is downloaded and built server-side (the @kotao/* dependencies install from npm — same as a CLI publish).
  3. On success the deployment activates and the status flips to success; on a build error it flips to failure.
  • On GitHub: the commit’s status check shows pending → success/failure.
  • In your Workspace: Website → Operations → Deployments shows every run live — queued → building → deployed, with the repo, branch, commit, duration, and the failure reason when a build breaks.
  • The connected branch deploys to the site’s live theme — treat it like a production branch and iterate on feature branches.
  • The build uses your committed files only; .dev.vars stays local.