6fe7d9c19f
**Preamble** 1. We're trying to setup a windows-based github self-hosted runner in the playwright-internal repo. 1. Commands on Windows are mandated to have total arguments length less then 32767 characters. 1. On windows, github self-hosted runner framework puts repository checkout at `c:\w\playwright-internal\playwright-internal` 1. Our scripts create a checkout at `c:\w\playwright-internal\playwright-internal\browser_patches\firefox\checkout` 1. One of the scripts in Firefox buildsystem tries to execute a command, passing lots of absolute paths to various webidl's 1. The command fails due to restriction in (2) **Problem** Firefox build fails since checkout is deeply nested and hits max arg size on windows. **Solution** This patch introduces a new variable `FF_CHECKOUT_PATH` that is respected by all browser-related scripts. This way we'll be able to checkout firefox to `c:\firefox` and avoid hitting long arguments limit. |
||
|---|---|---|
| .. | ||
| buildbots | ||
| chromium | ||
| ffmpeg | ||
| firefox | ||
| tools | ||
| webkit | ||
| winldd | ||
| checkout_build_archive_upload.sh | ||
| export.sh | ||
| prepare_checkout.sh | ||
| README.md | ||
| sanitize_and_compress_log.js | ||
| upload.sh | ||
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_upstreamremote in the checkout - create a
playwright-buildbranch 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.shif necessary - bump the
./browser_patches/firefox/BUILD_NUMBERnumber.
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. Then you can roll the browser:
$ node utils/roll_browser.js chromium 123456