Skip to content

Commit 679a380

Browse files
update shopify theme requirements (#458)
1 parent 8c835f9 commit 679a380

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/tools/shopify-cli.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,31 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1212

1313
[Shopify CLI](https://github.com/Shopify/cli) is a command-line tool that helps you build Shopify apps, themes, and custom storefronts. It provides functionality for initializing, building, developing, and deploying Shopify projects.
1414

15+
## Requirements
16+
17+
The tool only runs when the following conditions are met:
18+
19+
### File Types
20+
21+
- Only processes pull requests changing `*.liquid` files
22+
23+
### Configuration Files
24+
25+
- Requires either `.theme-check.yml` or `.theme-check.yaml` configuration file in the project root
26+
27+
### Directory Structure
28+
29+
- Requires the standard Shopify theme directory structure at the project root:
30+
- `assets/`
31+
- `config/`
32+
- `layout/`
33+
- `locales/`
34+
- `sections/`
35+
- `snippets/`
36+
- `templates/`
37+
38+
If any of these requirements are not met, the tool will not run.
39+
1540
## Validation Rules
1641

1742
The tool checks for:

0 commit comments

Comments
 (0)