This PR enables the github-action-benchmark action to save and deploy bench results to the gh-pages branch. This was disabled to avoid conflicts/overwrites with the documentation files since the current action cleans the directory on each new rebuild of the docs. The action has an option to keep_files but it doesn't allow us to specify which files to keep (in our case we only want to keep the bench data).
This is fixed by using a new GH pages deployment action which has an option for keeping only specific files and cleaning the rest (see updated release.yml).
One minor thing - the bench data will be displayed at https://willcrichton.net/flowistry/dev/bench. AFAIK this would only cause an issue if flowistry adds a dev crate as a dependency but in that unlikely scenario we can just switch to another path.
You can also check out an example of the bench results here.
This PR enables the
github-action-benchmark
action to save and deploy bench results to thegh-pages
branch. This was disabled to avoid conflicts/overwrites with the documentation files since the current action cleans the directory on each new rebuild of the docs. The action has an option tokeep_files
but it doesn't allow us to specify which files to keep (in our case we only want to keep the bench data).This is fixed by using a new GH pages deployment action which has an option for keeping only specific files and cleaning the rest (see updated
release.yml
).One minor thing - the bench data will be displayed at
https://willcrichton.net/flowistry/dev/bench
. AFAIK this would only cause an issue if flowistry adds adev
crate as a dependency but in that unlikely scenario we can just switch to another path.You can also check out an example of the bench results here.