Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
shopping-bag

GitHub Action

Deploy Shopify theme

2.0.1

Deploy Shopify theme

shopping-bag

Deploy Shopify theme

Deploy Shopify theme with Theme Kit

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Deploy Shopify theme

              
  uses: pgrimaud/action-shopify@2.0.1
Learn more about this action in pgrimaud/action-shopify

Choose a version

Publish Shopify theme for GitHub Actions

This GitHub action is part of a list of my Actions : https://github.com/pgrimaud/actions.

Usage

To use the action simply add the following lines to your workflow .yml file.

...
  steps:
      - uses: actions/checkout@v1
      - name: Shopify
        uses: pgrimaud/action-shopify@master
        env:
          SHOPIFY_PASSWORD: ${{ secrets.SHOPIFY_PASSWORD }}
          SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
          SHOPIFY_THEME_ID: ${{ secrets.SHOPIFY_THEME_ID }}
          THEME_PATH: ${{ secrets.THEME_PATH }}

You can see a repository with this action here : https://github.com/pgrimaud/shopify-debut

Required Secrets

First you have to generate a private app to get an API KEY on Shopify. Get API Access.

Then you'll need to provide some secrets to use the action.

  • SHOPIFY_PASSWORD: Your password from your private app previously created.
  • SHOPIFY_STORE_URL: Your store url. (e.g. demo.myshopify.com).
  • SHOPIFY_THEME_ID: Your theme id on your Shopify Store.
  • THEME_PATH: Path of your theme on your GitHub repository. If your theme is at the root of your repository, just use ./.

Optional Arguments

The optionnal argument you can add to improve theme deployment. Optionnal args are available on Theme Kit help.

Examples

...
  steps:
      - uses: actions/checkout@v1
      - name: Shopify
        uses: pgrimaud/action-shopify@master
        env:
          SHOPIFY_PASSWORD: ${{ secrets.SHOPIFY_PASSWORD }}
          SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
          SHOPIFY_THEME_ID: ${{ secrets.SHOPIFY_THEME_ID }}
          THEME_PATH: ${{ secrets.THEME_PATH }}
        with:
          args: --ignored-file=sections/*

Your can also combine multiple arguments :

...
  steps:
      - uses: actions/checkout@v1
      - name: Shopify
        uses: pgrimaud/action-shopify@master
        env:
          SHOPIFY_PASSWORD: ${{ secrets.SHOPIFY_PASSWORD }}
          SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
          SHOPIFY_THEME_ID: ${{ secrets.SHOPIFY_THEME_ID }}
          THEME_PATH: ${{ secrets.THEME_PATH }}
        with:
          args: --ignored-file=sections/* --timeout=30

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.