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

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

NOTE: this command downloads GBs of data.

This command will:

create a git browser checkout at ./browser_patches/firefox/checkout
create a browser_upstream remote in the checkout
create a playwright-build branch and apply all playwright-required patches to it.

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 ....

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

This script will:

Send a PR to the PlayWright repo to be reviewed.

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.

Yes, you can. For this:

pass path to your browser checkout as a second argument to prepare_checkout.sh script.
pass path to your browser checkout as a second argument to export.sh when exporting changes.