Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add canary releases doc (#16375)
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |