From 9d4530a405cfc31b2697d206a4eabc2d83e816fa Mon Sep 17 00:00:00 2001 From: Kyle Gach Date: Thu, 31 Aug 2023 10:01:07 -0600 Subject: [PATCH] E2E VT updates - Clarify current limitations - Add gotcha about React versions - Add `@latest` to `npx` command --- e2e-visual-tests.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/e2e-visual-tests.md b/e2e-visual-tests.md index edc4417c..321c1b87 100644 --- a/e2e-visual-tests.md +++ b/e2e-visual-tests.md @@ -10,6 +10,11 @@ description: Chromatic E2E Visual Tests capture snapshots of pages visited durin 🧪 **Experimental** We're actively integrating feedback from [early access users](https://forms.gle/w43XGAJXVWpAF5oC7), so the API and other details below may change. +Current limitations: + +- Not yet tested on Windows +- Only available for Playwright right now + @@ -44,6 +49,12 @@ If you aren't yet using Storybook in your project, install with: yarn add --dev @chromaui/test-archiver @chromaui/archive-storybook @storybook/cli @storybook/addon-essentials @storybook/server-webpack5 react react-dom ``` +
+ +💡 Note that if you are already using React in your project, you should install the version you are already using to avoid conflicts. The command above will install the latest version of each package. + +
+ ### If you are already using Storybook If you are already using Storybook in your project, install as a second Storybook with: @@ -143,7 +154,7 @@ The above snippet produces archives that look like this in Storybook: Now you can try manually running Chromatic against the archives with the project you just created (using the token you noted above): ```shell - npx chromatic --build-script-name=build-archive-storybook -t= + npx chromatic@latest --build-script-name=build-archive-storybook -t= ``` 3. **Run Chromatic on the archives in CI**