From e160adf29d86c30f315db9729e5961c1e6575c37 Mon Sep 17 00:00:00 2001 From: Simon Knott Date: Thu, 14 Nov 2024 08:40:40 +0100 Subject: [PATCH] address feedback --- docs/src/release-notes-js.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/src/release-notes-js.md b/docs/src/release-notes-js.md index 986068b419..3b901759c1 100644 --- a/docs/src/release-notes-js.md +++ b/docs/src/release-notes-js.md @@ -38,7 +38,7 @@ Learn more in the [aria snapshots guide](./aria-snapshots). - Added "previous" and "next" buttons to the HTML report to quickly switch between test cases. - New properties [`property: TestInfoError.cause`] and [`property: TestError.cause`] mirroring [`Error.cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause). -## Breaking: `chrome` and `msedge` channels switch to new headless mode +### Breaking: `chrome` and `msedge` channels switch to new headless mode Chromium recently introduced a new mode for [headless operation](https://developer.chrome.com/docs/chromium/headless). While Playwright was able to continue using the old, established mode in previous versions, the old mode got removed from the chromium binary and is now distributed separately. @@ -47,7 +47,7 @@ Chromium recently introduced a new mode for [headless operation](https://develop To prevent breaking changes, Playwright continues making both modes available in the standard `chromium` channel for the foreseeable future by downloading both distributables. Since branded browser distributables are subject to the removal of the old mode, Playwright uses the new mode with them starting with this version. This keeps your tests running, but it comes with changes in behavior that might affect your test suite. -### Am I affected? +#### Am I affected? This change affects you if you're using one of the following channels in your Playwright configuration: @@ -56,11 +56,11 @@ This change affects you if you're using one of the following channels in your Pl If your `playwright.config.ts` doesn't contain any `channel: '...'` options, or none of them specify one of the above channels, you're not affected by this change today. -### What do I need to do? +#### What do I need to do? -After updating to Playwright 1.50, run your test suite. If it still passes, you're good to go. If not, you will probably need to update your snapshots, and adapt some of your test code around PDF viewers and extensions. See [issue #33566](https://github.com/microsoft/playwright/issues/33566) for more details. +After updating to Playwright 1.49, run your test suite. If it still passes, you're good to go. If not, you will probably need to update your snapshots, and adapt some of your test code around PDF viewers and extensions. See [issue #33566](https://github.com/microsoft/playwright/issues/33566) for more details. -### Saving CI resources +#### Saving CI resources To keep both headless modes available, Playwright now downloads two different browser builds. One is regular headed chromium, and the other is a chromium headless shell. If you are running only headless tests, for example on CI, you can save resources by explictly specifying that you only need the headless shell: @@ -69,7 +69,7 @@ To keep both headless modes available, Playwright now downloads two different br npx playwright install chromium-headless-shell firefox webkit ``` -### Opt-in to new headless mode +#### Opt-in to new headless mode To prevent breaking changes in the future, we encourage you to try switching to the new headless mode today. You can do this by opting into the `chromium-next` channel. @@ -96,8 +96,6 @@ export default defineConfig({ }); ``` -See [issue #33566](https://github.com/microsoft/playwright/issues/33566) for more details on what's changing with the new headless mode. - ### Other breaking changes - There will be no more updates for WebKit on Ubuntu 20.04 and Debian 11. We recommend updating your OS to a later version.