Versioned documentation: keep the public default on the latest stable release - #4
Versioned documentation: keep the public default on the latest stable release#4Mmoncadaisla wants to merge 22 commits into
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.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 56c9bb581b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
… 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.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 973f0a5016
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…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.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8678e6ac8f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1665abdc0f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a320d4915a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…e checkbox, and inject the version provider when backfilling docs from pre-versioning tags.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 795fa4b73d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
… confirmed-absent gh-pages branch may bypass the guard.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5b872a67d6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…hyphen in the tag; build metadata may contain hyphens.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8626b341f0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
… stale local branch replays the same non-fast-forward rejection.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cf719da82f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| latest="false" | ||
| else | ||
| # v0.4.0 -> 0.4 | ||
| version="$(echo "${RELEASE_TAG#v}" | cut -d. -f1,2)" |
There was a problem hiding this comment.
Prevent older patches from replacing a stable line
When an older patch release is published or republished after a newer patch in the same minor line—for example, v0.3.3 after v0.3.4—both tags collapse to the 0.3 target, so the later event overwrites 0.3/ with the older documentation and the latest guard sees equal line values and permits it. Unlike the prior overlap finding, this occurs even when the runs are fully sequential, so the concurrency group does not prevent it; preserve and compare the full release version before replacing an existing stable line.
Useful? React with 👍 / 👎.
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.