shoplab-team/Shopify Theme Check Reporter
Runs Shopify Theme Check on Pull Requests and posts a formatted report comment on Pull Requests.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token for posting comments. Typically provide using secrets.GITHUB_TOKEN in the workflow. | yes | — |
| fail-on-warnings | Set to "true" to fail the action if warnings are found (in addition to errors). | no | false |
| node-version | Node.js version to use for running the check (passed to actions/setup-node). | no | 20.x |
| theme-check-package | The specific npm package version for theme check (e.g., @shopify/theme-check-node@latest). | no | @shopify/theme-check-node@latest |
Outputs
| name | description |
|---|---|
| error-count | Number of errors found by theme check. |
| warning-count | Number of warnings found by theme check. |
| comment-body-file | Path to the temporary file containing the generated comment body markdown. |
| fallback-comment-body | Fallback comment body used if the script failed to generate the report file. |