Skip to content

release: 2.1.0 - bundle React UI in CLI, stabilize guide routing, and harden packaging checks#11

Merged
night-slayer18 merged 9 commits intomainfrom
develop
Feb 9, 2026
Merged

release: 2.1.0 - bundle React UI in CLI, stabilize guide routing, and harden packaging checks#11
night-slayer18 merged 9 commits intomainfrom
develop

Conversation

@night-slayer18
Copy link
Copy Markdown
Member

Summary

This PR upgrades the monorepo from 2.0.0 to 2.1.0 and fixes the npm-install path so @opensyntaxhq/autodocs reliably generates React UI output on autodocs build.

What Changed

  • CLI packaging/runtime

  • Bundled UI assets into CLI package (ui-dist) for publish artifacts.

  • Added prepare-ui-dist + prepack flow in CLI so tarballs include React UI files.

  • Updated static build resolution to prefer bundled CLI UI assets and keep HTML fallback as safety.

  • Removed runtime dependence on building UI during consumer execution.

  • Packaging verification and CI gates

  • Added pack verification script to assert ui-dist/index.html and UI assets exist in tarball.

  • Added tarball smoke test that installs packed CLI into a temp fixture and runs autodocs build.

  • Wired these checks into preflight CI.

  • Added root scripts for pack verification and smoke testing.

  • Guide/route correctness

  • Switched guide routing to ID-based path (/guide/:id/:slug?) for stable links.

  • URL-encode/decode route IDs in UI paths and page resolution.

  • Updated markdown plugin guide IDs to deterministic short hashes derived from relative paths.

  • Updated guide metadata fields (fileName, module, source.file) to relative path semantics.

  • Test coverage improvements

  • Added/expanded unit tests for guide and section pages (including edge branches).

  • Added UI route/link tests for guide IDs.

  • Added Playwright guide navigation test.

  • Added core plugin guard tests to ensure examples plugin does not mutate entry identity fields.

  • Tooling/release hygiene

  • Bumped versions to 2.1.0 across root/workspaces and core version constant.

  • Improved scripts/version.js to also sync internal dependency/peer/dev/optional ranges.

  • ESLint config updates for JS config files and generated UI-dist ignores.

Validation

  • npm run build
  • npm run type-check
  • npm run lint
  • npm run test
  • npm run test:coverage
  • npm run format
  • npm run format:check

Notes for Upgraders

  • Guide URLs/IDs are now ID-based and may differ from older generated docs.
  • Run autodocs build after upgrading to regenerate docs-dist and docs.json with the new format.

sanitize theme values before applying them to the DOM
add ErrorBoundary fallback to protect route rendering
refactor search index reset path and update related tests

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
replace duplicated UI doc model types with core type imports
add tsconfig path mapping for core type resolution in UI

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
handle browser open failures in serve command with warning fallback
replace broad compilerOptions any-casts with typed conversion helpers
use fs.rm recursive cleanup and remove lint-prone infinite loop pattern

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
add semver and JSON/file validation to version script
set CLI author metadata
make e2e performance budget configurable via environment variable

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
generate deterministic guide IDs from relative markdown paths
encode/decode route IDs safely in UI links and page params
switch guide route to /guide/:id/:slug and keep readable slugs
add unit/e2e coverage for guide navigation and section edge branches

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
prepare ui-dist during prepack and include it in published files
remove runtime UI build dependency from static generation path
prefer bundled assets in buildReactUI and keep HTML fallback safety
update CLI tests for bundled-asset resolution behavior

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
verify npm pack contains ui-dist assets required for React output
add packed-tarball smoke test that runs autodocs build in temp fixture
wire checks into preflight workflow and root npm scripts
document local invocation and bundled-UI behavior in CLI README

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
add examples-plugin guards for identity stability and no-output path
fix eslint/js config handling for js files and generated ui-dist ignore
remove unnecessary jest global comments causing lint noise

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
update root and workspace package versions to 2.1.0
sync internal dependency and peerDependency ranges to ^2.1.0
update core VERSION constant and harden scripts/version.js to keep internal ranges aligned

Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 9, 2026

Deploy Preview for autodocshq ready!

Name Link
🔨 Latest commit 5538620
🔍 Latest deploy log https://app.netlify.com/projects/autodocshq/deploys/6989fc038a41f50008f16bb6
😎 Deploy Preview https://deploy-preview-11--autodocshq.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 9, 2026

Codecov Report

❌ Patch coverage is 94.76190% with 11 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
packages/ui/src/components/ErrorBoundary.tsx 89.18% 4 Missing ⚠️
packages/cli/src/commands/build.ts 89.28% 3 Missing ⚠️
packages/ui/src/lib/loaders.ts 96.38% 3 Missing ⚠️
packages/ui/src/pages/GuidePage.tsx 75.00% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 9, 2026

🚀 Deployed on https://pr-11--autodocshq.netlify.app

@github-actions github-actions Bot temporarily deployed to pull request February 9, 2026 15:24 Inactive
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 9, 2026

Preview Deployment

Your preview is ready.

URL: https://pr-11--autodocshq.netlify.app


Deployed from commit fe1d91f

@night-slayer18 night-slayer18 merged commit d92d4e5 into main Feb 9, 2026
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant