Skip to content

Commit

Permalink
bug 1540655: remote: document how to vendor Puppeteer; r=remote-proto…
Browse files Browse the repository at this point in the history
…col-reviewers,jdescottes

Differential Revision: https://phabricator.services.mozilla.com/D39660
  • Loading branch information
andreastt committed Aug 16, 2019
1 parent 6337ac1 commit f4d9623
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
35 changes: 35 additions & 0 deletions remote/doc/PuppeteerVendor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Vendoring Puppeteer
===================

As mentioned in the chapter on [Testing], we run the full [Puppeteer
test suite] on try. These tests are vendored in central under
_remote/test/puppeteer/_ and we have a script to pull in the most
recent changes.

We currently use [a fork of Puppeteer] with a small number of tweaks
and workaround to make them run against Firefox. These changes
will be upstreamed to Puppeteer when we feel more comfortable about
compatibility with Chrome.

To update the vendored copy of Puppeteer under _remote/test/puppeteer/_:

% ./mach vendor puppeteer
0:00.40 Removing old checkout from remote/test/puppeteer
0:00.56 Checking out firefox from https://github.com/andreastt/puppeteer.git to remote/test/puppeteer
0:03.35 Removing unnecessary files
0:03.35 Updating remote/test/puppeteer/moz.yaml
0:03.35 Registering changes with version control
0:03.73 Updated Puppeteer to firefox

This will replace the current checkout with a fresh copy from
the predefined remote, which currently is the `firefox` branch on
https://github.com/andreastt/puppeteer.git. You can override which
remote and commit to use with the `--remote` and `--committish` flags:

-c COMMITISH, --commitish COMMITISH
Repository tag or commit to update to.
--remote REMOTE Remote git repository.
--ignore-modified Ignore modified files in current checkout.

[Testing]: ./Testing.html
[Puppeteer test suite]: https://github.com/GoogleChrome/puppeteer/tree/master/test
1 change: 1 addition & 0 deletions remote/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Developers
Architecture.md
Prefs.md
CodeStyle.md
PuppeteerVendor.md


Bugs
Expand Down

0 comments on commit f4d9623

Please sign in to comment.