chore: add canary releases doc (#16375)

This commit is contained in:
Max Schmitt 2022-08-09 15:31:29 +02:00 committed by GitHub
parent b7e26270dd
commit 0013531c81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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 <kbd>Shift</kbd> on the keyboard `5` times.