Skip to main content

Connecting GitHub

Theme Deploy connects to GitHub in two steps: you sign in with GitHub, then install the Theme Deploy GitHub App on the repository (or organization) that contains your theme.

1. Sign in with GitHub​

From the dashboard, click Login with GitHub. You'll be redirected to GitHub to authorize Theme Deploy, then returned to the app. This lets Theme Deploy list the repositories you have access to.

2. Install the GitHub App​

If you haven't installed the Theme Deploy GitHub App yet, you'll be prompted to. Choose the account or organization that owns your theme repository, and grant access to all repositories or just the ones you need.

The GitHub App is what allows Theme Deploy to:

  • clone your repository during deployments (using short-lived installation tokens — your code is never stored permanently), and
  • receive push webhooks so deployments trigger automatically.

You can add more repositories or organizations later from the repository picker.

3. Select your repository​

Pick your theme repository from the list. When you select it, Theme Deploy:

  • saves the repository and its default branch as your deployment configuration, and
  • automatically queues a first deployment of the default branch, so you can verify everything works right away.
Repository layout

Your repository should contain a standard Shopify theme structure at its root (layout/, templates/, sections/, snippets/, assets/, config/, locales/). The config/settings_data.json and config/settings_schema.json files in your repo are ignored during deploys — the versions from your live theme are used instead. See How Deployments Work.

What happens next​

Head back to the dashboard: your first deployment should already be running. From now on, every push to GitHub triggers a deployment according to your branch rules.