Skip to content

Fix docs deployment to use single deploy step without force-push #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukidoescode merged 2 commits into from
May 11, 2026
Merged

Fix docs deployment to use single deploy step without force-push #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b025a07
Use single deploy step to avoid gh-pages push conflict
lukidoescode May 11, 2026
b5d0701
Disable force-push for gh-pages deployment
lukidoescode May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,33 +66,32 @@ jobs:
- name: Build book
run: mdbook build docs

- name: Deploy versioned docs
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ steps.app-token.outputs.token }}
folder: ./docs/book
target-folder: ${{ steps.target.outputs.destination }}
clean: false

- name: Generate versions.json and root redirect
- name: Prepare deployment
run: |
git fetch origin gh-pages
git worktree add /tmp/gh-pages origin/gh-pages
mkdir -p /tmp/meta

# Start from existing gh-pages content, then overlay new docs
cp -r /tmp/gh-pages /tmp/deploy
rm -rf /tmp/deploy/.git
mkdir -p /tmp/deploy/${{ steps.target.outputs.destination }}
cp -r ./docs/book/* /tmp/deploy/${{ steps.target.outputs.destination }}/

# Generate from assembled state so new versions are included
chmod +x .github/scripts/generate-versions-json.sh
.github/scripts/generate-versions-json.sh /tmp/gh-pages /tmp/meta/versions.json
.github/scripts/generate-versions-json.sh /tmp/deploy /tmp/deploy/versions.json

LATEST=$(python3 -c "import json; print(json.load(open('/tmp/meta/versions.json'))['latest'])")
LATEST=$(python3 -c "import json; print(json.load(open('/tmp/deploy/versions.json'))['latest'])")

chmod +x .github/scripts/generate-redirect.sh
.github/scripts/generate-redirect.sh "$LATEST" /tmp/meta/index.html
.github/scripts/generate-redirect.sh "$LATEST" /tmp/deploy/index.html

git worktree remove /tmp/gh-pages

- name: Deploy versions.json and root redirect
- name: Deploy to gh-pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ steps.app-token.outputs.token }}
folder: /tmp/meta
folder: /tmp/deploy
clean: false
force: false
Loading