benchmark-action / github-action-benchmark

GitHub Action for continuous benchmarking to keep performance
https://benchmark-action.github.io/github-action-benchmark/dev/bench/
MIT License
1.02k stars 152 forks source link

Doc issue: github-action-benchmark and docusaurus can not co exist #275

Closed darrenge closed 1 month ago

darrenge commented 1 month ago

The default branch for github-action-benchmark is "gh-pages". The default branch for docusaurus is "gh-pages". The problem is that when the documentation is updated in docusaurus, then docusaurus deletes gh-pages and recreates it with the new documentation pages. Obviously, this then wipes out the history of github-action-benchmarking.

The work around would to have github-action-benchmark on a separate branch.

ktrz commented 1 month ago

@darrenge we already have a param for that. gh-pages-branch

darrenge commented 1 month ago

Might be worth it to mention gh-pages might be affected by other apps.