shopify/theme-check-action

About this repo | Usage | Configuration

About this repo

shopify theme check on Shopify Theme Pull Requests using GitHub Actions.

Usage

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

# .github/workflows/theme-check.ymlname: Theme Checkon: [push]jobs:
theme-check:
name: Theme Checkruns-on: ubuntu-lateststeps:
- uses: actions/checkout@v4
- name: Theme Checkuses: shopify/theme-check-action@v2with:
theme_root: '.'# optional, could be './dist'token: ${{ github.token }}base: main

Configuration

Note:

For Theme Check Ruby support (v1.X.X), refer to the v1 documentation.

shopify/theme-check-action@v2 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 Shopify CLI@shopify/theme (v3.50+) 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.