Skip to content

fix: add CLI-only generation error boundary (#654) - #725

Merged
Jamie-BitFlight merged 3 commits into
mainfrom
fix/670-cli-error-boundary
Oct 10, 2026
Merged

Jamie-BitFlight merged 3 commits into
mainfrom
fix/670-cli-error-boundary

Conversation

@Jamie-BitFlight

Copy link
Copy Markdown
Contributor

Use a separate CLI entry module to report a concise error and set a nonzero exit status, while leaving the published ESM library entry and its import-time rejection behaviour unchanged. The CLI build points at src/cli.ts; the library still points at src/index.ts.

Draft pending standalone bundled-binary integration verification, build output inspection, CI and regression tests. This changes the CLI bundle entry and should be merged after verification of packaging invariants. Related #654 and #670.

@coderabbitai

coderabbitai Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 40 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: bitflight-devops/github-action-readme-generator/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ea5ec487-9e35-44f1-ac25-81d7b7d8350e

📥 Commits

Reviewing files that changed from the base of the PR and between edb05b4 and 8fe5e85.


📒 Files selected for processing (2)
  • src/cli.ts
  • vite.config.ts

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 91.81% 1009 / 1099
🔵 Statements 91.97% 1031 / 1121
🔵 Functions 95.03% 153 / 161
🔵 Branches 85.58% 552 / 645
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/cli.ts 0% 0% 100% 0% 3-7
Generated in workflow #1081 for commit 8fe5e85 by the Vitest Coverage Report Action

@Jamie-BitFlight Jamie-BitFlight left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Holistic review of PRs #717–#728

Reviewed b856af2892d1cb90f5ea8f7c19a7c9d6a99944fb against main at edb05b4eeea35e03df75b066b8ddd1d708de9f1c.

Assessment: correction required — critical packaging defect (P1).

The dynamic-import boundary is a coherent way to catch import-time execution failures while leaving the library entry's existing execution contract unchanged; process.exitCode = 1 also preserves normal completion/stream flushing. However, the changed build entry emits dist/bin/cli.js, while the package and Action still require dist/bin/index.js. Exact-head unit-workflow and real-repository integration logs confirm the build failure described inline.

The 688 passing unit tests do not verify this new binary: those workflow tests run before the build and can execute the tracked released artifact. After correcting the filename, build first and test only the newly generated dist/bin/index.js in a directory without node_modules, including successful generation and nonzero failure reporting. The separate combined-source probe exercised this boundary and passed the README contract verifier, but its esbuild/available-dependency harness is not evidence that this Vite+ package builds.

Separate pre-existing finding from the batch review (P1; do not attribute it to this PR): native Node 24.19.0 cannot import main's exact tracked dist/mjs/index.js with locked nconf@0.13.0: import { Provider } from 'nconf' fails during module linking. The library artifact's Git blob was verified, and the installed nconf entry/manifest match upstream v0.13.0 byte for byte; native nconf exposes default.Provider, not a named Provider. Main's source import is unchanged here. Track a separate compatible CommonJS-interop correction and native built-library consumer smoke test; this finding does not justify changing the library's execution semantics in #725.

Comment thread vite.config.ts
@Jamie-BitFlight
Jamie-BitFlight marked this pull request as ready for review October 10, 2026 23:02
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-10T23:05:33.333319Z 8fe5e85 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Jamie-BitFlight
Jamie-BitFlight merged commit 6a27eaa into main Oct 10, 2026
11 checks passed
@Jamie-BitFlight
Jamie-BitFlight deleted the fix/670-cli-error-boundary branch October 10, 2026 23:13
Jamie-BitFlight pushed a commit that referenced this pull request Oct 11, 2026
## [2.0.5](v2.0.4...v2.0.5) (2026-10-11)

### Bug Fixes

* add CLI-only generation error boundary ([#654](#654)) ([#725](#725)) ([6a27eaa](6a27eaa))
* **ci:** honor explicit Node versions before automatic detection ([95a9e68](95a9e68))
* **ci:** honor explicit Node versions in the test matrix ([#735](#735)) ([3f03f0d](3f03f0d))
* complete SVG writes before reporting success ([#717](#717)) ([170e499](170e499))
* consistently interpret GitHub Actions environment flag ([#670](#670)) ([#723](#723)) ([68756ad](68756ad))
* fail generation on formatting and requested save errors ([#654](#654)) ([#718](#718)) ([bb48434](bb48434))
* guard malformed runs metadata and preserve load error causes ([#720](#720)) ([c6caf7a](c6caf7a))
* load native ESM configuration and verify fresh package entry points ([5f92784](5f92784))
* load native ESM configuration and verify fresh package entry points ([#733](#733)) ([55746ed](55746ed))
* pair section log groups and honor Actions mode at output boundaries ([2d45100](2d45100))
* pair section log groups and honor Actions output mode ([#734](#734)) ([ceaa03a](ceaa03a))
* preserve empty metadata descriptions and cover reviewed errors ([3c0a181](3c0a181))
* preserve empty metadata descriptions and verify reviewed error paths ([#732](#732)) ([f8c0f4e](f8c0f4e))
* preserve original file read error as cause ([#722](#722)) ([05553e0](05553e0))
* validate consumed nested metadata descriptions ([#670](#670)) ([#729](#729)) ([330ab9a](330ab9a))
* validate README section configuration at input boundary ([#670](#670)) ([#726](#726)) ([40c9efd](40c9efd))
* verify declared defaults using their rendered projection ([beb2180](beb2180))
* verify empty metadata descriptions through the contract checker ([a5e2d31](a5e2d31))
@Jamie-BitFlight

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 2.0.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Jamie-BitFlight Jamie-BitFlight added the released This issue/pull request has been released. label Oct 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released This issue/pull request has been released.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant