From 298c62e720b331fc07172adc67d12a63ea181c2f Mon Sep 17 00:00:00 2001 From: Andrii Ieroshenko Date: Thu, 7 Sep 2023 20:54:51 -0700 Subject: [PATCH] Add suggestion to generate snapshots before the 1st run --- packages/jupyter-ai/ui-tests/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/jupyter-ai/ui-tests/README.md b/packages/jupyter-ai/ui-tests/README.md index 863ecf895..7a2df584e 100644 --- a/packages/jupyter-ai/ui-tests/README.md +++ b/packages/jupyter-ai/ui-tests/README.md @@ -37,6 +37,8 @@ jlpm install jlpm playwright install ``` +> Tests involve snapshot comparisons against a reference snapshots generated by the Github CI. If you are using an OS other than Linux, you will need to generate local snapshots before running the tests locally for the first time. See [Update the tests snapshots](#update-the-tests-snapshots) section for the instructions. + 3. Execute the [Playwright](https://playwright.dev/docs/intro) tests: ```sh @@ -49,7 +51,7 @@ will be opened in your browser at the end of the tests execution; see [Playwright documentation](https://playwright.dev/docs/test-reporters#html-reporter) for configuring that behavior. -## Update the tests snapshots +## Update the tests snapshots {#update-the-tests-snapshots} If you are comparing snapshots to validate your tests, you may need to update the reference snapshots stored in the repository. To do that, you need to execute the [Playwright](https://playwright.dev/docs/intro) command: