chore(cli): bundle with bun target node and publish from staged dir by RomanHotsiy · Pull Request #2637 · Redocly/redocly-cli

RomanHotsiy · 2026-03-04T14:46:51Z

What/Why/How?

Switch CLI build output to Bun bundling for Node (bun build --target node) instead of the previous TypeScript-only compile flow.
Fix bundled-runtime resolution issues by replacing runtime createRequire('../../package.json') patterns with static JSON imports in CLI runtime paths.
Add a built-in build-docs template fallback so bundled artifacts do not depend on template.hbs being present as a filesystem asset.
Replace publish-time package.json mutation/restore with a staged publish directory (packages/cli/.publish) and publishConfig.directory so changeset publish publishes from the staged manifest/artifacts.
Keep the staged directory minimal: bin/cli.js, bundled lib/index.js, README.md, LICENSE, and a stripped package.json (no deps/devDeps/scripts).
Update local pack/smoke/perf/release snapshot flows to use the staged directory.
Update CI jobs that execute e2e/pack/publish flows to ensure Bun is installed.

Reference

N/A

Testing

npm --workspace packages/cli run compile
node packages/cli/lib/index.js --help
npm run typecheck
npm run pack:prepare
npm run release (no unpublished packages in this run; verified publish-dir prepare/cleanup path)

Screenshots (optional)

N/A

Check yourself

Code changed? - Tested with Redoc/Realm/Reunite (internal)
All new/updated code is covered by tests
New package installed? - Tested in different environments (browser/node)
Documentation update considered

Security

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

Note

Medium Risk
Changes the CLI build and release/publish pipeline (bundling + staged publish directory), which could impact install/runtime behavior and npm publish correctness, but does not alter security-sensitive logic.

Overview
CLI distribution is reworked to ship as a Bun-bundled Node target: packages/cli now builds lib/index.js via bun build (with an npx bun fallback), and CI/e2e workflows install Bun and run a bundle step before tests.

Publishing/packing now happens from a staged directory: a new prepare-publish-dir script generates packages/cli/.publish with only the bin entrypoint, bundled output, README/LICENSE, and a minimal package.json; release, snapshot publish, and local pack scripts are updated to publish/pack that directory and then clean it up.

Bundling compatibility fixes: runtime package.json access is switched to a static JSON import (exposing redocVersion), and build-docs embeds a default Handlebars template fallback when template.hbs isn’t available as a file. Docker build no longer manually copies the template, and smoke fixtures are updated accordingly.

^{Reviewed by Cursor Bugbot for commit 4077b74. Bugbot is set up for automated code reviews on this repo. Configure here.}

changeset-bot · 2026-03-04T14:46:59Z

🦋 Changeset detected

Latest commit: 4077b74

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

This PR includes changesets to release 3 packages

Name	Type
@redocly/cli	Patch
@redocly/openapi-core	Patch
@redocly/respect-core	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

github-actions · 2026-03-04T14:49:00Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	79.91% (🎯 79%)	6689 / 8370
🔵	Statements	79.34% (🎯 79%)	6920 / 8721
🔵	Functions	83.13% (🎯 82%)	1356 / 1631
🔵	Branches	71.61% (🎯 71%)	4545 / 6346

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/cli/src/commands/build-docs/index.ts	93.33%	50%	100%	93.33%	53
packages/cli/src/commands/build-docs/utils.ts	59.45%	33.33%	85.71%	61.11%	51-72, 127, 134, 149
packages/cli/src/utils/package.ts	100%	100%	100%	100%

Generated in workflow #9325 for commit 4077b74 by the Vitest Coverage Report Action

github-actions · 2026-03-04T14:49:15Z

CLI Version	Mean Time ± Std Dev (s)	Relative Performance (Lower is Faster)
cli-latest	3.492s ± 0.034s	▓▓ 1.04x
cli-next	3.374s ± 0.018s	▓ 1.00x (Fastest)

github-actions · 2026-03-04T14:49:16Z

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

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1772635755
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1772635755
# or
npm install @redocly/respect-core@0.0.0-snapshot.1772635755

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

.changeset/olive-bobcats-happen.md

tatomyr

Had a brief look. Will give it another pass later.

tatomyr · 2026-03-12T07:53:24Z

packages/cli/src/commands/build-docs/index.ts

 import { performance } from 'node:perf_hooks';
 import { default as redoc } from 'redoc';

+import packageJson from '../../../package.json' with { type: 'json' };


It probably makes more sense to import it from utils/package.js.

packages/cli/src/utils/package.ts

tatomyr · 2026-03-12T08:04:07Z

tests/e2e/helpers.ts

 }

+function cleanUpStyledComponentWarnings(str: string): string {
+  return str.replace(/^styled-components: it looks like an unknown prop .*?(?:\r?\n|$)/gm, '');


I don't see the message anywhere. Why do wee need this?

tatomyr · 2026-03-12T08:06:20Z

scripts/release-publish.mjs

+  const result = spawnSync(command, args, {
+    cwd: rootDir,
+    stdio: 'inherit',
+    shell: process.platform === 'win32',


Are we going to publish from Win?

packages/cli/package.json

scripts/release-publish.mjs

packages/cli/scripts/prepare-publish-dir.mjs

package.json

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 1b232c3. Configure here.}

scripts/release-publish.mjs

tatomyr

Left a minor comment. Please also check this comment: #2637 (comment).
Otherwise LGTM.

packages/cli/scripts/compile-bundle.mjs

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

RomanHotsiy added 2 commits March 4, 2026 22:44

chore(cli): bundle with bun target node and publish from staged dir

84999a0

style: format publish-dir script

d4754ad

RomanHotsiy added the snapshot Create experimental release PR label Mar 4, 2026

RomanHotsiy removed the snapshot Create experimental release PR label Mar 4, 2026

RomanHotsiy added 7 commits March 4, 2026 22:51

fix(docker): install bun before pack preparation

072a87b

fix(cli): fallback to npx bun when bun is unavailable

7dcbf5e

chore(realm): add bun to the docker

008c0e0

fix(docker): include docs files in build context

62b8e8d

fix(docker): remove obsolete build-docs template copy

d35db98

test(smoke): refresh pre-built docs fixture for bundled cli

70fefcf

chore: add changeset

9515d93

RomanHotsiy marked this pull request as ready for review March 12, 2026 03:43

RomanHotsiy requested review from a team as code owners March 12, 2026 03:43

JLekawa reviewed Mar 12, 2026

View reviewed changes

.changeset/olive-bobcats-happen.md Outdated Show resolved Hide resolved

Apply suggestion from @JLekawa

b902fbf

JLekawa approved these changes Mar 12, 2026

View reviewed changes

tatomyr reviewed Mar 12, 2026

View reviewed changes

tatomyr reviewed Mar 16, 2026

View reviewed changes

packages/cli/package.json Outdated Show resolved Hide resolved

scripts/release-publish.mjs Show resolved Hide resolved

packages/cli/scripts/prepare-publish-dir.mjs Outdated Show resolved Hide resolved

package.json Show resolved Hide resolved

chore: fixes after review

1b232c3

cursor bot reviewed Apr 6, 2026

View reviewed changes

scripts/release-publish.mjs Outdated Show resolved Hide resolved

tatomyr reviewed Apr 6, 2026

View reviewed changes

packages/cli/scripts/compile-bundle.mjs Show resolved Hide resolved

tatomyr approved these changes Apr 7, 2026

View reviewed changes

Fix publish cleanup by throwing on non-zero status

4077b74

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

Conversation

RomanHotsiy commented Mar 4, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

Uh oh!

changeset-bot bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

github-actions bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

Uh oh!

tatomyr left a comment

Choose a reason for hiding this comment

Uh oh!

tatomyr Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

RomanHotsiy Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tatomyr Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

tatomyr Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tatomyr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RomanHotsiy commented Mar 4, 2026 •

edited by cursor bot

Loading

changeset-bot bot commented Mar 4, 2026 •

edited

Loading

github-actions bot commented Mar 4, 2026 •

edited

Loading

github-actions bot commented Mar 4, 2026 •

edited

Loading