Shopify / theme-check

The Ultimate Shopify Theme Linter
Other
333 stars 96 forks source link

Introduce `--update-docs` flag to synchronously update Theme Check resources (objects, filters, and tags) #707

Closed karreiro closed 1 year ago

karreiro commented 1 year ago

Fixes part of https://github.com/Shopify/theme-check/issues/706 (a following PR is going to update Shopify/theme-check-action)

Summary

This PR introduces a flag to synchronously update Theme Check documentation (objects, filters, and tags).

Context

When Theme Check is released, the most updated version of Shopify/theme-liquid-docs is embedded. Also, when some new filter is released, local Theme Check instances get auto upgraded asynchronously (so documentation is always updated on developers machines).

However, at CI environments, Theme Check uses the embedded documentation from the latest release, which makes the build of some CI-users fail.

How to test this PR

Post-release steps