Skip to content

Commit

Permalink
docs(docs-infra): document running docs examples in ivy mode (#33399)
Browse files Browse the repository at this point in the history
PR Close #33399
  • Loading branch information
gkalpak authored and AndrewKushnir committed Oct 25, 2019
1 parent e0428fe commit 26a6db2
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions aio/README.md
Expand Up @@ -34,17 +34,18 @@ Here are the most important tasks you might need to use:
* `yarn docs-test` - run the unit tests for the doc generation code.

* `yarn boilerplate:add` - generate all the boilerplate code for the examples, so that they can be run locally.
- Add the option `--local` to use your local version of Angular contained in the "dist" folder.
- Add the option `--ivy` to turn on `ivy` mode.
* `yarn boilerplate:add:ivy` - same as `boilerplate:add` but also turns on `ivy` mode.

* `yarn boilerplate:remove` - remove all the boilerplate code that was added via `yarn boilerplate:add`.
* `yarn generate-stackblitz` - generate the stackblitz files that are used by the `live-example` tags in the docs.
* `yarn generate-zips` - generate the zip files from the examples. Zip available via the `live-example` tags in the docs.

* `yarn example-e2e` - run all e2e tests for examples
- `yarn example-e2e --setup` - force webdriver update & other setup, then run tests
- `yarn example-e2e --filter=foo` - limit e2e tests to those containing the word "foo"
- `yarn example-e2e --setup --local` - run e2e tests with the local version of Angular contained in the "dist" folder
* `yarn example-e2e` - run all e2e tests for examples. Available options:
- `--setup`: generate boilerplate, force webdriver update & other setup, then run tests.
- `--local`: run e2e tests with the local version of Angular contained in the "dist" folder.
_Requires `--setup` in order to take effect._
- `--ivy`: run e2e tests in `ivy` mode.
- `--filter=foo`: limit e2e tests to those containing the word "foo".

> **Note for Windows users**
>
Expand Down

0 comments on commit 26a6db2

Please sign in to comment.