Skip to content

Commit

Permalink
Release docs: Update performance test instructions (#43015)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mamaduka authored Aug 5, 2022
1 parent 12b7960 commit 1933820
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/contributors/code/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,16 @@ These visual assets should maintain consistency with previous release posts; usi

The post should also include a performance audit at the end, comparing the current Gutenberg release with both the previous one and the latest WordPress major version. There are GitHub worfklows in place to do this comparison as part of the Continuous Integration setup, so the performance audit results can be found at the workflow run generated by the release commit in the [Performance Tests workflows](https://github.com/WordPress/gutenberg/actions/workflows/performance.yml) page, with the job name `Compare performance with current WordPress Core and previous Gutenberg versions`.

If the GitHub workflow fails, the performance audit can be executed locally using `bin/plugin/cli.js perf` and passing as parameters the tags to run the performance suite against, such as `bin/plugin/cli.js perf release/x.y release/x.z wp/a.b`.
If the GitHub workflow fails, the performance audit can be executed locally using `bin/plugin/cli.js perf` and passing the branches to run the performance suite against as parameters. In addition, the current major WP version can be passed to avoid running tests against the WP `trunk`. Example:

```
node ./bin/plugin/cli.js perf release/x.y release/x.z wp/a.b --wp-version wp.major
```

The performance values usually displayed in the release post are:

- Post Editor Loading Time (test named `load`)
- KeyPress Event (test named `typing`)
- Time to the first block (test named `firstBlock`)
- KeyPress Event (typing) (test named `type`)

#### 5. Publishing the post

Expand Down

0 comments on commit 1933820

Please sign in to comment.