Fix deployment of docs to gh-pages on release, blocked by PR previews - #722
Merged
Merged
Conversation
gh-pagesgh-pages on release, blocked by PR previews
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mkdocs gh-deployalways builds a parentless commit forgh-pages(the job's checkout only fetchesmaster, so it has no local history forgh-pagesto branch from), which needs--forceto push.--forcewas removed when PR previews (pr-preview/ongh-pages, seepull-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.mkdocs gh-deploywithmkdocs buildplus a manual deploy step: check out the realgh-pagestip into a worktree, replace everything exceptpr-preview/with the freshly built site, add.nojekyll, commit, and push normally (a true fast-forward, no force needed).Test plan
npm run buildpassesmkdocs buildpassesnpm run lintpassesnpm run test:jestpassesnpm run test:playwright-ct:allpassesgh-pagesstate (preservespr-preview/, deploys new content, no-ops when content is unchanged)deploy_docssucceeds on the next real release