ci(docs): versioned mdBook deploys + version-pinned release-note links#187
Merged
Conversation
Docs are a single "latest" gh-pages deploy, so release notes couldn't link to the docs *as of that release*. Add per-release versioned docs on the (legacy, branch-based) Pages flow — the flow that supports this cleanly via peaceiris destination_dir + keep_files: - release.yml `docs-version` job: on every release tag, mdbook build + deploy the book to gh-pages `/<tag>/` (keep_files) — a frozen copy. - ci.yml main deploy gains `keep_files: true` so those version subdirs survive; "latest" stays at the site root (existing URLs unaffected). - release.yml notes step rewrites `` `docs/foo.md` `` refs to `[docs/foo.md](https://gpu-eda.github.io/Jacquard/<tag>/foo.html)` — the version-pinned mdBook page. CHANGELOG keeps clean repo-relative paths. - CHANGELOG [Unreleased] gains a one-sentence summary lead-in (becomes the release intro). release-process.md documents the notes + versioned-docs conventions. Version picker across pages is a deliberate follow-up; this lands the version-pinned URLs the release notes need. Co-developed-by: Claude Code v2.1.201 (claude-opus-4-8)
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
1 participant
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.
Closes the "release notes should link to this release's docs" gap. The mdBook site is a single "latest" gh-pages deploy, so notes couldn't point to version-frozen pages.
What
On the legacy (branch-based) Pages flow — which supports this cleanly (peaceiris
destination_dir+keep_files), unlike the modern single-artifact Actions flow:release.ymldocs-versionjob: on every release tag,mdbook build→ deploy the book to gh-pages/<tag>/(keep_files: true). A frozen copy per release. Runs for real tags only; independent of the binary build.ci.ymlmain deploy: addkeep_files: trueso the/vX.Y.Z/subdirs survive. "latest" stays at the site root — existing URLs unaffected.release.ymlnotes step: rewrite`docs/foo.md`→[docs/foo.md](https://gpu-eda.github.io/Jacquard/<tag>/foo.html)— the version-pinned mdBook page. CHANGELOG keeps clean repo-relative paths.[Unreleased]: one-sentence summary lead-in (becomes the release intro).release-process.md: documents the notes + versioned-docs conventions.Validation
actionlintclean on both files (bar the pre-existing SC2129 in an unrelated step).docs/adr/…) both map correctly, subpaths preserved.mainpush (root still serves + no wipe) and the next release tag (/<tag>/appears, notes link resolves). I'll watch those.Notes / follow-up
versions.json+ theme dropdown) is deliberately deferred — this PR lands the version-pinned URLs the notes need; the picker is UI polish.keep_files: truenever deletes, so a deleted doc page leaves a stale.htmlat root — acceptable tradeoff for not breaking existing root URLs.