diff --git a/packages/desktop-client/README.md b/packages/desktop-client/README.md index 7ebc39a3397ca0d9a49b7b52e49efcd19af250c8..03b615faef1ce1a5c8c182fd3f2819637e869572 100644 --- a/packages/desktop-client/README.md +++ b/packages/desktop-client/README.md @@ -32,11 +32,12 @@ Prerequisites: #### Running against the local server -First start the dev server: +First start a dev instance: ```sh HTTPS=true yarn start ``` +Note the network IP address and port the dev instance is listening on. Next, navigate to the root of your project folder, run the standartised docker container, and launch the visual regression tests from within it. @@ -47,11 +48,11 @@ docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/ # If you receive an error such as "docker: invalid reference format", please instead use the following command: docker run --rm --network host -v ${pwd}:/work/ -w /work/ -it mcr.microsoft.com/playwright:v1.41.1-jammy /bin/bash -# Run the VRT tests: important - they MUST be ran against a HTTPS server -E2E_START_URL=https://192.168.0.178:3001 yarn vrt +# Run the VRT tests: important - they MUST be ran against a HTTPS server. Use the ip and port noted earlier +E2E_START_URL=https://ip:port yarn vrt # To update snapshots, use the following command: - E2E_START_URL=https://192.168.0.178:3001 yarn vrt --update-snapshots + E2E_START_URL=https://ip:port yarn vrt --update-snapshots ``` #### Running against a remote server diff --git a/upcoming-release-notes/2287.md b/upcoming-release-notes/2287.md new file mode 100644 index 0000000000000000000000000000000000000000..5c4954092ea868bdfc607492095644c50ddb2328 --- /dev/null +++ b/upcoming-release-notes/2287.md @@ -0,0 +1,6 @@ +--- +category: Maintenance +authors: [youngcw] +--- + +Update vrt instructions