Copy and paste benchmarks before and after gh-pages deployment (#909) #88
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Publish documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Configure Git Credentials | |
| run: | | |
| git config user.name github-actions[bot] | |
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
| - uses: actions/cache@v4 | |
| with: | |
| key: mkdocs-material-${{ env.cache_id }} | |
| path: .cache | |
| restore-keys: | | |
| mkdocs-material- | |
| - run: pip install mkdocs-material mkdocstrings[python] | |
| # ====== Backup the benchmarks from gh-pages ====== | |
| # This is necessary because the benchmarks are not included in the documentation build process. | |
| # So we need to backup the benchmarks from gh-pages and restore them after the documentation is built. | |
| - name: Backup benchmarks from gh-pages | |
| run: | | |
| git fetch origin gh-pages | |
| # create worktree bound to local gh-pages, tracking origin/gh-pages | |
| git branch -f gh-pages origin/gh-pages || true | |
| mkdir -p ghp && git worktree add ghp gh-pages || true | |
| if [ -d ghp/benchmarks ]; then | |
| tar -C ghp -czf /tmp/benchmarks.tgz benchmarks | |
| fi | |
| # IMPORTANT: remove worktree so gh-pages isn't checked out anywhere | |
| git worktree remove ghp --force || true | |
| echo "Backed up benchmarks from gh-pages" | |
| # ====== Deploy the documentation ====== | |
| - name: Deploy documentation | |
| run: mkdocs gh-deploy --force | |
| # ====== Restore the benchmarks onto gh-pages ====== | |
| # This is necessary because the benchmarks are not included in the documentation build process. | |
| # So we need to restore the benchmarks onto gh-pages after the documentation is built. | |
| - name: Restore benchmarks onto gh-pages | |
| run: | | |
| # Refresh remote tracking and recreate a clean worktree | |
| git fetch origin gh-pages | |
| git worktree add -B gh-pages ghp origin/gh-pages | |
| if [ -f /tmp/benchmarks.tgz ]; then | |
| tar -C ghp -xzf /tmp/benchmarks.tgz | |
| git -C ghp add -A | |
| git -C ghp commit -m "Restore benchmarks after gh-deploy" || echo "No changes" | |
| git -C ghp push origin gh-pages | |
| fi | |
| git worktree remove ghp --force || true |