How to Automate Deployments to Shopify Stores
This guide shows how to set up automatic deployment of a Shopify theme to an existing store. The article, including the creation of two environments: live and stage.
Join the DZone community and get the full member experience.Join For Free
E-commerce is surging under the lockdown, with thousands of businesses opening online stores every week. This means more work for developers, including those working with Shopify themes. With the numbers growing, deploying, and managing multiple shops at once can get tricky. Buddy solves this problem with delivery pipelines, a fast and elegant solution that lets you automate deployments and preview changes before going live.
Step 1: Configuring Theme Kit CLI
Start with downloading Shopify's Theme Kit CLI. The CLI lets you run various operations in the context of Shopify themes by running commands. You can find installation instructions for your OS on their documentation page.
Adding a New Private App
When you're done, you'll need to create a new private app in the store's admin panel to gain access to Shopify's API. Complete the following steps.
The password is required to run Shopify Theme Kit CLI commands – make sure to copy it as we'll need it later on!
Step 2: Bootstrapping Theme Project
For this guide, we'll be using the default Debut Shopify theme. To bootstrap our project we will download it using Theme Kit CLI. Complete the following steps.
Downloading Theme With Theme Kit CLI
After creating a new theme, we have to download it.
- Create a directory on your computer and go there from the command line.
- Before we download the theme, we have to know its ID. To list all themes installed in your store, run this command:
You should get this output from the command with two new themes - one for production and one for staging environment:
The number in brackets is the theme's ID. We can use it now to download the files from Shopify:
Lastly, check if all files were downloaded successfully. Your folder structure should look like this:
Setting up Git Repository
In this tutorial, we'll use Buddy as the code provider. You can use any VCS if you wish, though, as Buddy integrates with all types of Git providers, including GitHub, Bitbucket, and GitLab. In this case, reproduce the steps below, but select a different provider at the beginning.
Start with setting up a new repository in the folder with your theme.
Sign in to your Buddy account, create a new project, and select Buddy as the provider.
Enter the name and click the button to proceed.
For improved security, we'll use SSH for authentication. Make sure that you have added your SSH key in Buddy's account settings.
Add the remote to the repository on your computer using the copied URL.
Create an initial commit with all files from the folder.
Create and check out the
stage branch. We'll use it to deploy changes to the preview environment.
With everything ready, push the commit to the remote repository on Buddy.
Step 3: Delivery to Production
With the theme safe and sound in the repository, it's time to configure two pipelines that will be deploying changes to the Shopify store.
The live pipeline will reflect what is visible to your customers on the Shopify store. It will be watching for changes on the
- Click Add a new pipeline on the project's page.
- Set the name to
Manualas the trigger mode.
masteras the deployment branch.
- Click the blue-button to finish the configuration.
masterbranch should always be ready for deployment to live – be sure that whatever your merge is 100% tested and verified.
You can expand the options menu and provide the URL to your store in the Target website URL so that you can quickly access it from the pipeline view after the deployment.
Deployment to Shopify
With the pipeline configured, we can add the Shopify deployment action by completing the following:
- Look up Shopify on the action list.
- In the integration box, paste the URL to your shop and click the button when ready.
- Buddy will redirect you to your store settings. Install Buddy in the store to proceed.
- With the integration added, select the theme and shop to which you want to deploy.
Step 4: Delivery to Stage
Creating the staging pipeline works the same as with the production pipeline. The differences are the branch from which we deploy, and the triggering mode:
Deployment to Shopify
Add the Shopify action once again. This time, change the theme to which the action will deploy.
Step 4: Testing Delivery Pipelines
You should now have two pipelines: one for previewing changes on stage (automatic), and another one with deployment to production (manual).
Let's see how they work in practice. First, make some changes to your theme and push them to your staging branch. You will see that Buddy will automatically pick up those changes and upload them to
My theme - stage.
Check the website and see if everything looks fine. If yes, merge the branch
master and run the production pipeline. If you host the source code on Buddy, you can merge branches in the Code tab.
Step 5: Expansion
This guide covers only one of the issues that can be solved with pipelines. A cool feature of Buddy is that it lets you quickly expand existing pipelines without disrupting your workflow. For example, you can do the following:
Published at DZone with permission of Beata Zubek. See the original article here.
Opinions expressed by DZone contributors are their own.