Check benchmarks on CI - Githubissues

This PR follows from #94

Description

What is this PR

[ ] Bug fix
[ ] Addition of a new feature
[x] Other

Why is this PR needed? To test the benchmarks.

What does this PR do? We test the benchmarks on CI rather than with tests.

References from other Python packages using asv to benchmark:

numpy: they have a separate benchmark job in Github Actions.
- astropy: they have a cron job. Something like this is likely what we need for running the internal benchmarks.
- scikit-image: they have a job in CI for relative benchmarking but they also run a benchmark check along the tests CI (see here).
napari: they also do relative benchmarks in CI, and also a quick check

Currently we are running a very basic check. We can look into further extending this with maybe something closer to the napari or numpy approaches (see below).

References

This PR follows from #94 and relates to issue #9. It should be rebased to main after #94 is squash-and-merged.

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

If this PR breaks any existing functionality, please explain how and why.

Does this PR require an update to the documentation?

If any features have changed, or have been added. Please explain how the documentation has been updated (and link to the associated PR). See here for details.

Checklist:

[ ] The code has been tested locally
[ ] Tests have been added to cover all new functionality (unit & integration)
[ ] The documentation has been updated to reflect any changes
[ ] The code has been formatted with pre-commit

brainglobe / brainglobe-workflows

Check benchmarks on CI #96