Shopify GitHub integration for Oxygen
The Shopify GitHub app enables you to connect a GitHub account to your Shopify admin. This connection enables you to make and track changes to Hydrogen storefront code, and enables you to collaborate with other developers to share progress.
The Shopify GitHub integration enables you to do the following tasks:
- Connect Hydrogen storefronts to any organization or repository associated with your GitHub account
- Create and manage different versions of a Hydrogen storefront without affecting other versions on your storefront
- Keep your Hydrogen storefront up to date with commits to a branch
- Track changes to your Hydrogen storefront code with version control
How it worksAnchor link to section titled "How it works"
The Shopify GitHub integration enables you to connect your Hydrogen storefront code to the Oxygen hosting platform. When you push commits to a connected Git repository, the commits trigger a deployment with a preview URL to the environment, enabling you to quickly preview your changes throughout the development process.
Learn more about how Oxygen works.
Connection to GitHubAnchor link to section titled "Connection to GitHub"
You can connect only one GitHub account to your Shopify login. After you connect your Shopify login to a GitHub account, your Shopify login can connect repositories and branches that the Shopify GitHub app has access to.
If multiple users need to manage connections to a repository, then each user needs to authorize the Shopify GitHub app for their own account.
To disconnect your GitHub account or organization from the Shopify store, you can uninstall the Shopify GitHub app through GitHub.
Change a GitHub account into a GitHub organizationAnchor link to section titled "Change a GitHub account into a GitHub organization"
If you've changed your GitHub user into a GitHub organization while having the Shopify GitHub app installed, then you need to uninstall and reinstall the app so that Shopify can connect to new repositories.
GitHub permissionsAnchor link to section titled "GitHub permissions"
The Shopify GitHub app requires the following permissions to access certain data in your GitHub account or organization:
|Read-only access||deployments, metadata|
|Read and Write access||administration, code, pull requests, secrets, workflows|
LimitationsAnchor link to section titled "Limitations"
- Branch connections and commits from GitHub to Shopify can be a maximum of 50 MB overall, and 5 MB for each file.
- The number of pushes and pulls that you can make using the Shopify GitHub integration is controlled by standard GitHub app rate limits.
Getting startedAnchor link to section titled "Getting started"
To learn how to connect your account or organization to GitHub and connect a Hydrogen storefront to a Git repository, refer to Getting started with Oxygen.
Repository connection managementAnchor link to section titled "Repository connection management"
After you've connected a Hydrogen storefront to a Git repository, certain actions to the Shopify GitHub app or within GitHub might have an impact on your connection. The following table describes the expected impact that actions might have on your connection:
|Action||Reversible?||Impact||Suspend the Shopify GitHub app||✗||Permanently disconnects all connected storefronts from their associated repositories.|
|Delete the Shopify GitHub app||✗||Permanently disconnects all connected storefronts from their associated repositories.|
|Remove the Shopify GitHub app's access to a repository that's connected to a storefront||✓||
Disconnects the connected storefronts from the associated repository.
When you restore the app's access to the repository, the connection is rebuilt and the storefronts are restored to a working state.
|Delete a repository||✗||Permanently disconnects all connected storefronts from the associated repository.|
|Archive a repository||✓||
Disconnects all connected storefronts from the associated repository.
When you unarchive the repository, the connection is rebuilt and the storefronts are restored to a working state.
|Transfer a repository to another account||✗||Permanently disconnects all connected storefronts from the associated repository.|