Boris-code / playwright.dev

Documentation website for Playwright

playwright.dev

This website is built using Docusaurus v2. Content is pulled from the microsoft/playwright repo.

Development

Setup the repo

npm install

Roll docs

SRC_DIR=../playwright npm run roll

Remove old release

node src/versions.js --delete 1.16

Run dev server

npm run start-nodejs

See package.json for other languages (java, python, .NET).

Run prod build and serve

npm run build
npm run serve

Running this on Windows

If you don't already, you might need to set the default shell to bash.

npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"

You can revert it later, if you have issues, by doing:

npm config delete script-shell

In some cases, the postinstall script doesn't auto-run after npm install, in which case, you can run that manually:

npm run postinstall

That should bring your environment to a state ready for testing.

To roll the docs in PowerShell, make sure you set the env variable correctly, i.e.:

$env:SRC_DIR="C:\Users\user\src\playwright"; npm run roll

Run end-to-end tests

Run on local machine

Run this on one terminal:

npm run start-nodejs

and this on another, it will automatically use the local docusaurus server:

npx playwright test nodejs

Run on different environment

You can set the BASE_URL=https://playwright.dev env var, otherwise http://localhost:3000 gets used by default.

Publishing Doc Changes After a Release

Cherry-picking

1. Go to the Cherry-picking GitHub Actions workflow
2. Execute it with the version number e.g. 1.25 and a comma separate list of commit SHA hashes (from the main branch)
3. Wait for a PR getting created, review it and merge it

Stable docs rolling

1. Go to the Release GitHub Actions workflow
2. Execute it with the version number e.g. 1.25 and wait for the PR getting created. The PR will copy changes from the release branch in playwright repo.
3. Review the PR and merge it.