feat: automate docs version snapshot during release

[chhoumann]

Summary

• add a semantic-release prepare hook that snapshots docs for stable releases
• add a stable-only docs versioning script with idempotent behavior when snapshot already exists
• derive docs lastVersion dynamically from docs/versions.json
• include docs version artifacts in release commit assets
• install docs dependencies in release workflow and include docs lockfile in cache key

Closes #1109

Summary by CodeRabbit

• New Features

  • Automated documentation versioning: releases now create and manage versioned docs so stable release docs are snapshot and served automatically.

• Chores

  • CI/CD improvements: dependency installation extended to include the docs workspace and dependency caching updated to reduce rebuilds and speed releases.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
quickadd	Ready	Preview	Feb 22, 2026 0:15am

[coderabbitai]

📝 Walkthrough

Walkthrough

Automates docs versioning in the release prepare phase: adds a semantic-release plugin and an ES module script that snapshot docs for stable releases, updates docs config to use versions.json, expands release assets, and updates CI to install and cache docs dependencies.

Changes

Cohort / File(s)	Summary
Release plugin & script scripts/release/docs-versioning-plugin.cjs, scripts/release/version-docs.mjs	Adds a semantic-release prepare plugin that validates nextRelease.version, skips prereleases, and invokes a script which runs cd docs && bun run docusaurus docs:version <version> when needed; includes logging and error propagation.
Docs configuration docs/docusaurus.config.js	Replaces hardcoded lastVersion and static version entry with dynamic values derived from docs/versions.json (latestStableVersion) and conditionally spreads lastVersion and a dynamic versions entry.
Release config package.json	Registers ./scripts/release/docs-versioning-plugin.cjs in release.plugins and adds documentation artifacts to the @semantic-release/git assets (docs/versions.json, docs/versioned_docs/**/*, docs/versioned_sidebars/*.json).
CI workflow .github/workflows/release.yml	Extends Bun cache key to include docs/bun.lock and adds a step to install dependencies in docs (cd docs && bun install) during the release workflow.

Sequence Diagram

sequenceDiagram
    participant SR as "semantic-release"
    participant PL as "docs-versioning-plugin"
    participant VD as "version-docs.mjs"
    participant Bun as "Bun / Docusaurus"
    participant Git as "Git (release commit)"

    SR->>PL: prepare(nextRelease.version)
    PL->>PL: validate semantic X.Y.Z
    alt prerelease
        PL-->>SR: skip docs snapshot
    else stable
        PL->>VD: spawn with version arg
        VD->>VD: check versions.json & snapshot exists?
        alt snapshot exists
            VD-->>PL: skip (already versioned)
        else snapshot missing
            VD->>Bun: cd docs && bun run docusaurus docs:version <version>
            Bun-->>VD: generate versioned_docs & sidebars
            VD->>VD: ensure docs/docusaurus.config.js updated (lastVersion, versions entry)
            VD-->>PL: success
        end
        PL-->>SR: prepare complete
    end
    SR->>Git: commit docs artifacts + config updates

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐇 I hopped through release scripts today,
Bun and Docusaurus showed the way,
Snapshotted verses, set the lastVersion true,
Now docs and releases dance in view — hooray!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: automating documentation version snapshots during the release process.
Linked Issues check	✅ Passed	The PR implements all key requirements from issue #1109: automated docs versioning via semantic-release, dynamic lastVersion configuration, docs artifact inclusion in release commits, and docs dependency installation in CI workflow.
Out of Scope Changes check	✅ Passed	All changes directly support the objective of automating docs versioning during release; no unrelated modifications detected.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 1109-automate-docs-version-snapshot-+-lastversion-update-on-each-release

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[cloudflare-workers-and-pages]

Deploying quickadd with    Cloudflare Pages

Latest commit:	e4979a2
Status:	✅  Deploy successful!
Preview URL:	https://4fa9bc04.quickadd.pages.dev
Branch Preview URL:	https://1109-automate-docs-version-s.quickadd.pages.dev

View logs

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 5 additional findings.

[coderabbitai]

🧹 Nitpick comments (1)

docs/docusaurus.config.js (1)

8-13: Redundant docsVersions = [] in the catch block.

Because docsVersions is already initialised to [] on line 8 and require only reassigns it on success, the catch assignment is a no-op — the value never changed from the initial [].

♻️ Proposed simplification

 let docsVersions = [];
 try {
   docsVersions = require('./versions.json');
-} catch {
-  docsVersions = [];
-}
+} catch { /* versions.json absent (pre-first-release); keep [] */ }

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/docusaurus.config.js` around lines 8 - 13, The variable docsVersions is
pre-initialized to [] and the catch block redundantly reassigns docsVersions =
[]; remove the redundant assignment inside the catch so the try/catch simply
attempts to set docsVersions = require('./versions.json') and silently falls
back to the pre-initialized value if require throws; update the catch to be
empty (or optionally add a brief comment) and leave the symbols docsVersions and
require('./versions.json') as the markers to locate the change.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/docusaurus.config.js`:
- Around line 8-13: The variable docsVersions is pre-initialized to [] and the
catch block redundantly reassigns docsVersions = []; remove the redundant
assignment inside the catch so the try/catch simply attempts to set docsVersions
= require('./versions.json') and silently falls back to the pre-initialized
value if require throws; update the catch to be empty (or optionally add a brief
comment) and leave the symbols docsVersions and require('./versions.json') as
the markers to locate the change.

[github-actions]

🎉 This PR is included in version 2.12.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀