Skip to content

fix: fail generation on formatting and requested save errors (#654) - #718

Merged
Jamie-BitFlight merged 3 commits into
mainfrom
fix/670-propagate-generation-errors
Oct 10, 2026
Merged

Jamie-BitFlight merged 3 commits into
mainfrom
fix/670-propagate-generation-errors

Conversation

@Jamie-BitFlight

Copy link
Copy Markdown
Contributor

Addresses the confirmed catch-and-continue paths in #654 and #670. Preserve logging while rethrowing the original failure. Draft: existing formatter tests currently assert the old fallback and must be updated to verify rejection, with a save-failure regression and full CI verification before merge.

@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 59 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: cd701e78-2e6f-40fe-81b9-4501f8c05eda

📥 Commits

Reviewing files that changed from the base of the PR and between edb05b4 and 9ad8bb1.


📒 Files selected for processing (3)
  • __tests__/prettier.test.ts
  • src/prettier.ts
  • src/save.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

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 92.06% 1010 / 1097
🔵 Statements 92.22% 1032 / 1119
🔵 Functions 95.03% 153 / 161
🔵 Branches 85.84% 552 / 643
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/prettier.ts 100% 100% 100% 100%
src/save.ts 0% 0% 0% 0% 17-24
Generated in workflow #1078 for commit 9ad8bb1 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 9ad8bb1ce4e64994b0fd8de027e7c36db4f24ff3 against main at edb05b4eeea35e03df75b066b8ddd1d708de9f1c.

Assessment: the current revision is correct; ready for final verification. No blocking defect found.

Requested configuration-save failure is reproducible: with the destination set to a directory, main logs EISDIR and resolves, while this head rejects with the same original error. Successful saves and the explicit save: false opt-out are preserved. generateReadme returns the save promise, so the rejection reaches its caller; #725 supplies the CLI reporting boundary once its packaging defect is corrected.

The updated formatter test at this head intentionally expects rejection, so the earlier fallback-test failure at 74f67c3 is obsolete. Its deliberately invalid numeric formatter input establishes forwarding behavior, not a real metadata-triggered formatter defect; production usage wraps the description as a string. No valid-string formatter failure was reproduced, and this review does not invent one.

Both current-head Node jobs and rebuilt third-party integrations are green (Node 24). Requested-save regression coverage is the remaining nonblocking suggestion.

Comment thread src/save.ts
@Jamie-BitFlight
Jamie-BitFlight marked this pull request as ready for review October 10, 2026 22:44
@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-10T22:45:40.176678Z 9ad8bb1 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 bb48434 into main Oct 10, 2026
11 checks passed
@Jamie-BitFlight
Jamie-BitFlight deleted the fix/670-propagate-generation-errors branch October 10, 2026 23:12
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