Shopify offers a GitHub app to connect your Shopify and GitHub accounts. Use it when developing [themes](/docs/storefronts/themes/best-practices/version-control) and [Hydrogen storefronts](/docs/storefronts/headless/hydrogen/deployments/github).

## Connect Shopify and GitHub

Install the [Shopify GitHub app](https://github.com/apps/shopify) to connect your accounts.

Your Shopify account can only be connected to one GitHub account, which is why we recommend using [organization accounts](#organization-accounts), which enable more flexible access control.

### Organization accounts

We recommend using [GitHub organizations](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations) if possible. Organizations work with multiple individual GitHub accounts, enabling easier collaboration for teams, and more secure access control for GitHub repositories and Shopify stores.

Organization accounts are particularly helpful if you need to [transfer repository ownership](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository), which is common for agencies and freelance developers.

### Personal accounts

You can connect your personal GitHub account to Shopify, but you can only have one Shopify account connected to one personal GitHub account at a time. That's why we recommend using [organization accounts](#organization-accounts) if possible.

You can convert a [personal GitHub account to an organization](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization).

## Required GitHub permissions

For security reasons, we recommend granting access permission on a per-repository basis, instead of granting them for all repositories in your account or organization.

<table width="100%">
  <thead>
    <tr>
      <th><b>Read and write access</b></th>
      <th><b>Read access</b></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>
        <ul>
          <li>Repository permissions</li>
          <li>Administration</li>
          <li>Contents</li>
          <li>Dependabot secrets</li>
          <li>Pull requests</li>
          <li>Secrets</li>
          <li>GitHub Actions</li>
          <li>Workflows</li>
        </ul>
      </td>
      <td>
        <ul>
          <li>
            Account permissions
            <ul>
              <li>Email addresses</li>
            </ul>
          </li>
          <li>
            Organization permissions
            <ul>
              <li>Members</li>
            </ul>
          </li>
          <li>
            Repository permissions
            <ul>
              <li>Deployments</li>
            </ul>
          </li>
          <li>
            Events
            <ul>
              <li>Delete</li>
              <li>Organization</li>
              <li>Public</li>
              <li>Pull request</li>
              <li>Push</li>
              <li>Workflow run</li>
              <li>Workflow job</li>
            </ul>
          </li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>

## Disconnect Shopify and GitHub

You can disconnect your Shopify and GitHub accounts in your GitHub settings:

1. Open your [GitHub settings for app authorizations](https://github.com/settings/apps/authorizations)
1. Beside the Shopify app, click **Revoke**.

Check the GitHub docs for more details on [deleting GitHub apps](https://docs.github.com/en/apps/maintaining-github-apps/deleting-a-github-app).

## Troubleshooting and known limitations

- If you're connecting a new development store, then you can't set up the GitHub app on the initial login after the store is created. Log out of your development store and log in again through the Partner Dashboard before proceeding.
- If you access GitHub with SAML/SSO, you need an active SAML session to use the Shopify GitHub app. You can create a new SAML session by going to `https://github.com/orgs/{YOUR_ORGANIZATION}/sso`.
- If your GitHub organization enables SAML/SSO and you already had the Shopify GitHub app installed, then you'll need to [re-authorize all your GitHub apps](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on#about-oauth-apps-github-apps-and-saml-sso), including the Shopify app.
- The Shopify GitHub app doesn't support the [IP allow list](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization) feature of GitHub Enterprise Cloud.
- If you [convert your user account to an organization](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization), then you'll need to uninstall and reinstall the Shopify GitHub app.
- When connecting a repository, if you don't see the one you want to connect in the list of available repositories, then the GitHub organization owner will need to [update the repository access settings](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access) for the Shopify GitHub app.

## Using GitHub in Shopify development

<div class="resource-card-grid">
  <div>
  <a class="resource-card" href="/docs/storefronts/themes/tools/github" data-theme-mode="">
    <div class="resource-card__indicator-container"><img
     src="/assets/resource-cards/theme"
     data-alt-src="/assets/resource-cards/theme-dark"
     aria-hidden="true"
     class="resource-card__icon themed-image"></div>
    <h3 class="resource-card__title">
      GitHub integration for themes
    </h3>
    <p class="resource-card__description">Link your themes to GitHub repositories for two-way synchronization and version control</p>
  </a>
</div></p>

<p><div>
  <a class="resource-card" href="/docs/storefronts/headless/hydrogen/deployments/github" data-theme-mode="">
    <div class="resource-card__indicator-container"><img
     src="/assets/resource-cards/hydrogen"
     data-alt-src="/assets/resource-cards/hydrogen-dark"
     aria-hidden="true"
     class="resource-card__icon themed-image"></div>
    <h3 class="resource-card__title">
      Hydrogen CI/CD with GitHub
    </h3>
    <p class="resource-card__description">Set up continuous integration and deployment for your Hydrogen storefronts</p>
  </a>
</div>
</div>