Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swissspidy/compare-wp-performance
Comparing performance between two WordPress core releases with benchmarking
https://github.com/swissspidy/compare-wp-performance
Last synced: 19 days ago
JSON representation
Comparing performance between two WordPress core releases with benchmarking
- Host: GitHub
- URL: https://github.com/swissspidy/compare-wp-performance
- Owner: swissspidy
- License: apache-2.0
- Created: 2023-07-18T12:42:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T09:29:58.000Z (28 days ago)
- Last Synced: 2024-10-27T04:04:04.730Z (24 days ago)
- Language: Shell
- Size: 1.75 MB
- Stars: 16
- Watchers: 3
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# compare-wp-performance
Easily compare performance between two WordPress core releases with benchmarking.
Based on [this document](https://docs.google.com/document/d/1aionUJ9N35WWk3CwY5mfepRzf3psrJ0HJhw4B2Bsp_0/edit)
and the [handbook entry on benchmarking WordPress PHP performance](https://make.wordpress.org/performance/handbook/measuring-performance/benchmarking-php-performance-with-server-timing/#preparing-a-wordpress-site-for-server-timing-benchmarks),
this repository provides a [GitHub Action](https://github.com/features/actions) to automate this process.
## Usage
### Manually
Run the following command in the terminal:
```shell
./run.sh [old=latest] [new=trunk] [skip_init=false] [output=markdown] [skip_formatting=false] [print_to_files=false]
```
By default, it compares the latest stable release with the current trunk version. So `./run.sh` is the same as `./run.sh latest trunk`.
You can choose different versions of course. For example, to compare with the current RC:
```shell
./run.sh latest 6.3-branch
```
To skip the initialization steps when you want to run the benchmarks multiple times after another:
```shell
./run.sh latest trunk true
```
To test a specific WP version by ZIP file:
```shell
./run.sh latest https://wordpress.org/wordpress-6.3-RC2.zip
```
The default output is as Markdown tables. To get output data as CSV without formatted numbers:
```shell
./run.sh latest trunk false csv true
```
To pipe that output into (CSV) files:
```shell
./run.sh latest trunk false csv true true
```
This will result in four CSV files with the individual table results.
### GitHub Actions
This repository provides a GitHub Action to compare benchmarks of two separate WordPress versions.
The results are posted as a [job summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/).
By default, it compares the latest stable release with the current trunk version. You can choose different versions of course.
**Note:** if you do not have access to run GitHub Action in this repository, you can fork it.