About this repo | Usage | Configuration
shopify theme check
on Shopify Theme Pull Requests using GitHub Actions.
Add shopify/theme-check-action@v2
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@v4
- name: Theme Check
uses: shopify/theme-check-action@v2
with:
theme_root: '.' # optional, could be './dist'
token: ${{ github.token }}
base: main
Note:
For Theme Check Ruby support (
v1.X.X
), refer to thev1
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) Whentoken
is set, only the files that contain a diff with this ref (branch, tag or commit) will have GitHub check annotations.