Your First Workflow
Overview
Section titled “Overview”A workflow is a visual pipeline that defines how your theme code moves from GitHub to your Shopify store(s). This guide walks you through creating your first deployment workflow.
What is a Workflow?
Section titled “What is a Workflow?”A workflow consists of:
- Blocks: Individual steps (e.g., checkout code, merge content, deploy)
- Connections: How data flows between blocks
- Configuration: Settings for each block (target store, theme ID, etc.)
Creating a Basic Workflow
Section titled “Creating a Basic Workflow”Depending on your plan, when you load a new workflow, you may see different default blocks. The free plan includes only the basic blocks, while paid plans include additional blocks like backup.
Step 1: Open the Workflow Builder
Section titled “Step 1: Open the Workflow Builder”- In the Deployify app, click Workflows in the sidebar
- Click “Create Workflow”
Step 2: Select Your Repository
Section titled “Step 2: Select Your Repository”- Choose the connected GitHub repository (if more than one is connected)
- Select the branch you want to deploy from
Step 3: Add Workflow Blocks
Section titled “Step 3: Add Workflow Blocks”A minimal deployment workflow needs:
Checkout Block (Auto-added)
Section titled “Checkout Block (Auto-added)”- Pulls your code from GitHub
- No configuration needed
Content Merge Block (Auto-added)
Section titled “Content Merge Block (Auto-added)”- Merges live Shopify theme customizations with your repository code
- Configuration:
- Store handle: Your store’s myshopify.com domain (e.g.,
mystore.myshopify.com) - Theme ID: The theme to merge from
- Store handle: Your store’s myshopify.com domain (e.g.,
Deploy Block (Auto-added)
Section titled “Deploy Block (Auto-added)”- Pushes the merged code to Shopify
- Configuration:
- Store handle: Target store
- Theme ID: Target theme (can be existing or new)
Step 4: Save and Test
Section titled “Step 4: Save and Test”- Click “Save Workflow”
- Give your workflow a name (e.g., “development-deploy”)
- Click “Run Now” to test manually
Understanding Workflow Execution
Section titled “Understanding Workflow Execution”When you run a workflow:
- Checkout: Fetches latest code from GitHub
- Backup: Creates a backup of the target theme (only on paid plans)
- Content Merge: Combines live Shopify changes with your repo
- Deploy: Pushes result to target store/theme
- Logs: Real-time execution logs appear in the panel
Automatic Deployment (Push-to-Deploy)
Section titled “Automatic Deployment (Push-to-Deploy)”Enable automatic deployment on every Git push:
- Open your workflow
- Toggle “Auto-deploy on push” and Save your workflow
Now every push to your selected branch triggers the workflow automatically.
Troubleshooting
Section titled “Troubleshooting”“Failed to save workflow”
- Ensure all required block configurations are filled
- Check that store handles are valid myshopify.com domains
- Verify theme IDs are numeric (found in Shopify admin URL)
“Deployment failed”
- Check execution logs for specific error messages
- Common issues: invalid store credentials, theme ID doesn’t exist
