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.
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
filters.json
file (data/shopify_liquid/documentation/filters.json
) with the one aboveshopify-dev theme init
sections/footer.liquid
file (line ~192, around thelogin_button
filter)bin/theme-check <theme_directory> | grep sections/footer.liquid
bin/theme-check <theme_directory> --update-docs | grep sections/footer.liquid
Post-release steps