shopify/theme-check-action

About this repo | Usage | Configuration

About this repo

Theme Check on Shopify Theme Pull Requests using GitHub Actions.

Usage

Add shopify/theme-check-action to the workflow of your Shopify theme.

# .github/workflows/theme-check.yml
name: Theme Check
on: [push]
jobs:
  theme-check:
    name: Theme Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Theme Check
        uses: shopify/theme-check-action@v1
        with:
          theme_root: '.' # optional, could be './dist'
          token: ${{ github.token }}
          base: main

Configuration

The shopify/theme-check-action accepts the following arguments:

• theme_root - (optional, default: '.') Path from repo root to the root of the theme (e.g. './dist').
• flags - (optional) theme-check command line flags. (e.g. '--fail-level suggestion')
• version - (optional, default: latest) specific theme-check version to use.
• token - (optional) result of ${{ github.token }} to enable GitHub check annotations.
• base - (optional) When token is set, only the files that contain a diff with this ref (branch, tag or commit) will have GitHub check annotations.