playwright/browser_patches
2020-02-25 20:34:58 -08:00
..
buildbots chore(docs): update win buildbot setup docs 2020-02-24 14:08:54 -08:00
firefox browser(firefox): support BrowserContext.setExtraHTTPHeaders (#1111) 2020-02-25 17:24:06 -08:00
tools devops: prettify telegram messages 2020-02-07 12:42:20 -08:00
webkit browser(webkit): no_startup_window on linux (#1117) 2020-02-25 20:34:58 -08:00
checkout_build_archive_upload.sh devops: do not assume that checkout exists 2020-02-12 18:19:00 -08:00
download.sh devops: combine webkit-wpe and webkit-gtk together 2020-01-17 16:27:07 -08:00
export.sh fix(devops): use full SHAs in diffs 2019-12-16 16:17:56 -08:00
prepare_checkout.sh devops(scripts): export diffs instead of patches 2019-12-10 15:41:58 -08:00
README.md docs: we are Playwright, not PlayWright 2020-02-04 08:01:25 -08:00
upload.sh devops: combine webkit-wpe and webkit-gtk together 2020-01-17 16:27:07 -08:00

Contributing Browser Patches

Firefox and WebKit have additional patches atop to expose necessary capabilities.

Ideally, all these changes should be upstreamed. For the time being, it is possible to setup a browser checkout and develop from there.

1. Setting up local browser checkout

From the playwright repo, run the following command:

$ ./browser_patches/prepare_checkout.sh firefox <path to checkout>

(you can optionally pass "webkit" for a webkit checkout)

If you don't have a checkout, don't pass a path and one will be created for you in ./browser_patches/firefox/checkout

NOTE: this command downloads GBs of data.

This command will:

  • create a browser_upstream remote in the checkout
  • create a playwright-build branch and apply all playwright-required patches to it.

2. Developing a new change

You want to create a new branch off the playwright-build branch.

Assuming that you're under ./browser_patches/firefox/checkout:

$ git checkout -b my-new-feature playwright-build
$ # develop my feature on the my-new-feature branch ....

3. Exporting your change to playwright repo

Once you're happy with the work you did in the browser-land, you want to export it to the playwright repo.

Assuming that you're in the root of the playwright repo and that your browser checkout has your feature branch checked out:

$ ./browser_patches/export.sh firefox <path to checkout>

This script will:

  • create a new patch and put it to the ./browser_patches/firefox/patches/
  • update the ./browser_patches/firefox/UPSTREAM_CONFIG.sh if necessary
  • bump the ./browser_patches/firefox/BUILD_NUMBER number.

If you omit the path to your checkout, the script will assume one is located at ./browser_patches/firefox/checkout

Send a PR to the Playwright repo to be reviewed.

4. Rolling Playwright to the new browser build

Once the patch has been committed, the build bots will kick in, compile and upload a new browser version to all the platforms.

You can check the CDN status:

$ ./browser_patches/tools/check_cdn.sh

As the builds appear, you can roll to a new browser version in the ./package.json file.