yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/packages
History
Dmitry Gozman f745bf1fbc
chore: bring in folio source (#6923) 
- Source now lives at `src/test`.
- Former folio tests live at `tests/playwright-test`.
- We use `src/test/internal.ts` that exposes base test without
  Playwright fixtures for most tests (to avoid modifications for now).
- Test types live in `types/testFoo.d.ts`.
- Stable test runner is installed to `tests/config/test-runner` during `npm install`.
- All deps including test-only are now listed in `package.json`.
  Non-test deps must also be listed in `build_package.js` to get included.
2021-06-06 17:09:53 -07:00
..
common
chore: do not bundle api.json and protocol.yml (#6841)
2021-06-02 14:01:05 -07:00
installation-tests
feat(test): introduce npx playwright test (#6816)
2021-06-03 08:07:55 -07:00
playwright-chromium
api: export all browsers from every package (#3128)
2020-07-24 16:36:00 -07:00
playwright-core
devops: playwwright-core installation should not touch browser registry (#4089)
2020-10-08 11:42:56 -07:00
playwright-firefox
api: export all browsers from every package (#3128)
2020-07-24 16:36:00 -07:00
playwright-test
chore: bring in folio source (#6923)
2021-06-06 17:09:53 -07:00
playwright-webkit
api: export all browsers from every package (#3128)
2020-07-24 16:36:00 -07:00
.gitignore
api: export all browsers from every package (#3128)
2020-07-24 16:36:00 -07:00
build_package.js
chore: bring in folio source (#6923)
2021-06-06 17:09:53 -07:00
README.md
chore: use bash instead of sh in code blocks (#6847)
2021-06-02 18:23:06 +02:00

README.md

Managing and Publishing Playwright Packages

Overview

  • Playwright ships multiple packages to NPM. All packages that are published to NPM are listed as folders under //packages/.
  • Playwright's root package.json is never published to NPM. It is only used for devmode, e.g. when running npm install with no arguments or installing from github.
  • Playwright dependencies for all packages are the same and are managed with the root package.json.
  • Playwright browser versions for all packages are the same and are managed with the browsers.json.

Note

As of May 20, 2020, the only exception is the playwright-electron package that doesn't follow the pack and is published manually. This is due to it's pre-1.0 status.

Building NPM package

To build a package that will be shipped to NPM, use //packages/build_package.js script. The script populates package folder with contents, and then uses npm pack to archive the folder.

As of May 20, 2020, //packages/build_package.js does the following:

  • copies certain files and folders from playwright-internal to the subpackage (e.g. //lib, //types, //LICENSE etc)
  • generates package.json and puts it in the subpackage
  • generates browsers.json and puts it in the subpackage
  • uses npm pack to pack the subpackage folder
  • removes all the files that were added during the process

To build playwright package and save result as ./playwright.tgz file:

./packages/build_package.js playwright ./playwright.tgz

To debug what files are put into the folder, use --no-cleanup flag and inspect the package folder:

./packages/build_package.js playwright ./playwright.tgz --no-cleanup
ls ./packages/playwright # inspect the folder

Testing packages

To test packages, use //packages/installation-tests/installation-tests.sh.

Publishing packages

All package publishing happens exclusively over CI/CD using the //utils/publish_all_packages.sh script.