Skip to content

Commit

Permalink
Add performance metrics to README (#26891)
Browse files Browse the repository at this point in the history
  • Loading branch information
estherkim committed Feb 20, 2020
1 parent f56cdd4 commit caf985d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions build-system/tasks/performance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
Use `gulp performance` to run this test. It measures performance for the current branch compared to the current release. By default, the command first needs to compile minified runtime and components from the current branch by executing the `gulp dist` task. To skip this step, use the `--nobuild` flag, but the task will throw an error if the dist files are missing. Only the runtime and components used by documents from the configured URLs are compiled.

The `config.json` file contains settings. If you set `headless` to `false`, you will be able to watch the test run in Chrome. The default value for `runs` is 100, which takes ~10 minutes to run, and generates results with ~5% margin of error. Differences larger than this should be investigated. The `urls` array of strings must be set before running the test, and each URL will be tested separately.

This test measures the following metrics: `visible`, `first paint`, `first contentful paint`, `largest contentful paint`, `time to interactive`, `max first input delay`, and `cumulative layout shift`.

0 comments on commit caf985d

Please sign in to comment.