Skip to content

Fix deployment of docs to gh-pages on release, blocked by PR previews - #722

Merged
adamkudrna merged 1 commit into
masterfrom
bugfix/preserve-pr-previews-in-docs-deploy
Jul 31, 2026
Merged

Fix deployment of docs to gh-pages on release, blocked by PR previews#722
adamkudrna merged 1 commit into
masterfrom
bugfix/preserve-pr-previews-in-docs-deploy

Conversation

@adamkudrna

@adamkudrna adamkudrna commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

  • mkdocs gh-deploy always builds a parentless commit for gh-pages (the job's checkout only fetches master, so it has no local history for gh-pages to branch from), which needs --force to push. --force was removed when PR previews (pr-preview/ on gh-pages, see pull-request-preview.yml) were introduced, to avoid wiping them — but that also means the push is now rejected as a non-fast-forward every time, so no release docs have deployed since v0.63.1.
  • Replace mkdocs gh-deploy with mkdocs build plus a manual deploy step: check out the real gh-pages tip into a worktree, replace everything except pr-preview/ with the freshly built site, add .nojekyll, commit, and push normally (a true fast-forward, no force needed).
  • Commit message for the deploy now references the React UI release version and source SHA.

Test plan

  • npm run build passes
  • mkdocs build passes
  • npm run lint passes
  • npm run test:jest passes
  • npm run test:playwright-ct:all passes
  • Reproduced the original failure and verified the fix against a throwaway git remote mirroring the real gh-pages state (preserves pr-preview/, deploys new content, no-ops when content is unchanged)
  • Confirm deploy_docs succeeds on the next real release

@github-actions github-actions Bot added the fix Fixing a bug label Jul 31, 2026
@adamkudrna adamkudrna added maintenance and removed fix Fixing a bug labels Jul 31, 2026
@adamkudrna adamkudrna changed the title Preserve PR previews when deploying release docs to gh-pages Fix deployment of docs to gh-pages on release, blocked by PR previews Jul 31, 2026
@adamkudrna
adamkudrna merged commit 9bbaf15 into master Jul 31, 2026
13 checks passed
@adamkudrna
adamkudrna deleted the bugfix/preserve-pr-previews-in-docs-deploy branch July 31, 2026 15:43
@github-project-automation github-project-automation Bot moved this to ✅ Done in The Board Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

1 participant