From 0013531c8152a5a77a65e8679ea820df988bc0b7 Mon Sep 17 00:00:00 2001 From: Max Schmitt Date: Tue, 9 Aug 2022 15:31:29 +0200 Subject: [PATCH] chore: add canary releases doc (#16375) --- docs/src/canary-releases-js.md | 42 ++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/src/canary-releases-js.md diff --git a/docs/src/canary-releases-js.md b/docs/src/canary-releases-js.md new file mode 100644 index 0000000000..bf05685b0f --- /dev/null +++ b/docs/src/canary-releases-js.md @@ -0,0 +1,42 @@ +--- +id: canary-releases +title: "Canary Releases" +--- + +Playwright for Node.js has a canary releases system. + +It permits you to **test new unreleased features** instead of waiting for a full release. They get released daily on the `next` NPM tag of Playwright. + +It is a good way to **give feedback to maintainers**, ensuring the newly implemented feature works as intended. + +:::note + +Using a canary release in production might seem risky, but in practice, it's not. + +A canary release passes all automated tests and is used to test e.g. the HTML report, Trace Viewer, or Playwright Inspector with end-to-end tests. + +::: + +``` +npm install -D @playwright/test@next +``` + +## Next npm Dist Tag + +For any code-related commit on `main`, the continuous integration will publish a daily canary release under the `@next` npm dist tag. + +You can see on [npm](https://www.npmjs.com/package/@playwright/test?activeTab=versions) the current dist tags: + +- `latest`: stable releases +- `next`: next releases, published daily +- `beta`: after a release-branch was cut, usually a week before a stable release each commit gets published under this tag + +## Using a Canary Release + +``` +npm install -D @playwright/test@next +``` + +## Documentation + +The stable and the `next` documentation is published on [playwright.dev](https://playwright.dev). To see the `next` documentation, press Shift on the keyboard `5` times.