Skip to content

Commit

Permalink
Handbook: Polish the Gutenberg release docs, performance audit section (
Browse files Browse the repository at this point in the history
#32770)

* Update the GB release docs, perf audit section

Update the Gutenberg release documentation to expand how to find the performance audit already run in GitHub workflows.

* Polish wording.
  • Loading branch information
priethor authored Jun 17, 2021
1 parent 7fc4197 commit d91786a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/contributors/code/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,13 @@ These visual assets should maintain consistency with previous release posts; usi

#### 4. Running the performance tests

Your 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. You can use `bin/plugin/cli.js perf` to automatically do this for you by 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`
Your 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`.

The performance values usually displayed in the release post are:
- Post Editor Loading Time (test named `load`)
- KeyPress Event (test named `typing`)

#### 5. Publishing the post

Expand Down

0 comments on commit d91786a

Please sign in to comment.