chore: add benchmark action

[TimothyMakkison]

Added benchmark workflow

Description

Added github-action-benchmark to run for changes to main. I've tried to include the changes from the previous discussion here #419.

Resovles #477

This needs a branch called gh-pages to visualize the benchmarks, See here for more information.

[codecov]

Codecov Report

Merging #504 (099a76a) into main (630fd17) will decrease coverage by 0.55%.
The diff coverage is n/a.

❗ Current head 099a76a differs from pull request most recent head 2feacfe. Consider uploading reports for the commit 2feacfe to get more accurate results

@@            Coverage Diff             @@
##             main     #504      +/-   ##
==========================================
- Coverage   90.90%   90.36%   -0.55%     
==========================================
  Files         170      174       +4     
  Lines        5905     5977      +72     
  Branches      754      758       +4     
==========================================
+ Hits         5368     5401      +33     
- Misses        371      410      +39     
  Partials      166      166              

see 19 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[TimothyMakkison]

From comment

IMO the benchmarks should run on each PR shouldn't they?
But the results should only be updated when merged onto main. WDYT?

Enabling the benchmark for all pull requests will result in the file being written to and is not recommended, I could either add a separate workflow for pull requests or try to use save-data-file with github.event_name != 'pullrequest' (not sure if this is possible)

[TimothyMakkison]

Why did it take 6 hours for the CI to fail?

[latonz]

@TimothyMakkison no Idea, which job took so long?

[TimothyMakkison]

Looks like the test. Wonder if github was having issues yesterday.