Skip to content

Commit

Permalink
Add instructions for pruning the benchmark history (#1077)
Browse files Browse the repository at this point in the history
  • Loading branch information
erikvanoosten authored Oct 11, 2023
1 parent 262a5c0 commit f068456
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions prune-benchmark-history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Pruning the benchmarks report page

Benchmarks are run on every commit, even in pull requests. This causes the historic graphs on
https://zio.github.io/zio-kafka/dev/bench/ to contain so many results that it becomes unreadable. Rather than limiting
the number of items in the graph (which is supported by the github action that generates the page), we keep the
benchmark results of _all_ master commits, but only keep 1 month of pull request commits.

The process is currently manual. Here are the instructions:

* Make sure `jq` is installed
* Checkout the `gh-pages` branch
* Execute the following command in the root of the project:
```shell
scripts/prune-benchmark-history.sh
```
* Commit and push changes

0 comments on commit f068456

Please sign in to comment.