Versioned documentation: keep the public default on the latest stable release - #246
Merged
Merged
Conversation
…e-releases and dev deployed alongside.
…only covers the root path.
…rsioning site stays live through the migration.
…d workflow-level group can drop a pending release run, losing its latest-alias move.
…ke as version identifiers.
…nch in a job with contents: write.
…he 'latest' alias.
…ust not overwrite the stable X.Y that 'latest' points to.
… tag uses that tag's workflow definition, which has no manual trigger.
… must not repoint the public default.
…rough the workflow, since gh-pages pushes alone never reach Pages.
…very push attempt; the resolve-time check could act on stale state when releases overlap.
…er build cannot overwrite dev/ or rc/ content.
…he public default.
…in publish order.
…e checkbox, and inject the version provider when backfilling docs from pre-versioning tags.
… confirmed-absent gh-pages branch may bypass the guard.
…hyphen in the tag; build metadata may contain hyphens.
… stale local branch replays the same non-fast-forward rejection.
alxmrs
approved these changes
Aug 19, 2026
alxmrs
left a comment
alxmrs
left a comment
Member
There was a problem hiding this comment.
LGTM, thank you for finding the right set of documentation generating technologies.
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
2 participants
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.
Why
Publishing the
v0.4.0-rc.1pre-release replaced the public docs site with unreleased content: the site deploys frommainas a single version, andmainnow is the RC. Pre-release docs should be available, but the public default should stay on the latest stable release.What
Docs are now versioned with the Zensical fork of mike. Each version lives in its own directory on a
gh-pagesbranch, with a version selector on every page. Pages still publishes through the existing artifact flow, so the Pages source setting stays as it is.latest(public default)maindev/rc/, titled with the tagX.Y/Safeguards worth knowing about:
latestnever moves backward (av0.3.4afterv0.4.0won't repoint the site) and can never point atrc.-rc.Nsuffix in the tag routes torc/even if the pre-release checkbox was forgotten.dev,rc) are newest-wins under concurrent builds; stable releases deploy in publish order.contents: write).After merging (one-time)
github-pages→ deployment branches and tags → add tag rulev*. Today onlymainmay deploy, which would reject release-triggered runs.mainwith refv0.3.3, version0.3, "latest" ticked.Until step 2 runs, the old site stays live — the workflow refuses to publish a site that has no default version yet.
Notes
latestback and delete a version.rctitling, idempotent re-runs,zensical build, and the unit suite.