Skip to content

feat(cli): render build-docs with Redoc CE 3 - #3092

Draft
ivankropyvnytskyi wants to merge 13 commits into
mainfrom
feat/update-build-docs-command
Draft

ivankropyvnytskyi wants to merge 13 commits into
mainfrom
feat/update-build-docs-command

Conversation

@ivankropyvnytskyi

@ivankropyvnytskyi ivankropyvnytskyi commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

What/Why/How?

Replaces Redoc 2 with Redoc 3 in the build-docs command.

  • New options: --openapi (replaces the deprecated --theme.openapi), --inlineBundle (embed the scripts instead of loading them from the CDN), --disableTelemetry (off by default).
  • Supports AsyncAPI descriptions and GraphQL schemas next to OpenAPI 3.0/3.1/3.2.

Not finished yet: After Redoc 3 is released: set the exact version in packages/cli/package.json, regenerate the e2e snapshots and the smoke page, and verify the CDN mode.

Reference

Redocly/redocly#25296
Redocly/redocly#27095

Testing

Unit and e2e tests, smoke page regenerated.

Screenshots (optional)

Check yourself

  • This PR follows the contributing guide
  • All new/updated code is covered by tests
  • Core code changed? - Tested with other Redocly products (internal contributions only)
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update has been considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

@changeset-bot

changeset-bot Bot commented Sep 7, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 2ee8a6b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@redocly/cli Minor
@redocly/openapi-core Minor
@redocly/respect-core Minor
@redocly/client-generator Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@ivankropyvnytskyi ivankropyvnytskyi added the snapshot Create experimental release PR label Sep 11, 2026
Comment thread packages/cli/package.json Fixed
@ivankropyvnytskyi ivankropyvnytskyi added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Sep 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📦 A new experimental 🧪 version v0.0.0-snapshot.1789131837 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1789131837

⚠️ Note: This is a development build and may contain unstable features.

@github-actions

Copy link
Copy Markdown
Contributor

Performance Benchmark (Lower is Faster)

CLI Version Bundle Lint Check Config
cli-latest ▓ 1.00x (Fastest) ▓ 1.00x (Fastest) ▓ 1.00x (Fastest)
cli-next ▓ 1.01x ± 0.01 ▓ 1.01x ± 0.01 ▓ 1.00x ± 0.01

@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 78.58% (🎯 78%) 14475 / 18420
🔵 Statements 78.33% (🎯 78%) 15575 / 19882
🔵 Functions 82.11% (🎯 81%) 2957 / 3601
🔵 Branches 71.6% (🎯 71%) 10723 / 14976
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
packages/cli/src/commands/build-docs/index.ts 96.15% 72.22% 100% 96.15% 85
packages/cli/src/commands/build-docs/utils.ts 55.26% 41.93% 71.42% 56.75% 47-59, 62-66, 71, 146-154, 168
packages/cli/src/utils/package.ts 100% 100% 100% 100%
Generated in workflow #11775 for commit 93fcf20 by the Vitest Coverage Report Action

@ivankropyvnytskyi ivankropyvnytskyi removed the snapshot Create experimental release PR label Sep 11, 2026
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.

3 participants