Repository navigation
fix: validate README section configuration at input boundary (#670) - #726
Conversation
|
Warning Review limit reachedYou'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. View limit details
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. Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d4eeea2c83
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Jamie-BitFlight
left a comment
Jamie-BitFlight
left a comment
There was a problem hiding this comment.
Holistic review of PRs #717–#728
Reviewed d4eeea2c839860720ef5281ad815af7812606df9 against main at edb05b4eeea35e03df75b066b8ddd1d708de9f1c.
Assessment: simplify before merge — confirmed compatibility regression (P2).
With a real config file containing sections: ['title', 'custom'], main updates the title and ignores the unknown name; this head aborts before generation and leaves the title stale. The dispatcher already has an explicit unknown-section no-op. Non-array object/string configurations do crash main, so the array-shape guard addresses a real problem; the added closed-domain rejection is not needed for that correction.
My recommendation is to retain the necessary sequence-shape check and preserve unknown-name tolerance. An intentional strict rejection would require an explicit compatibility decision, documentation and the required breaking-change release header, but there is no demonstrated generator requirement for it. Single and repeated CLI --sections options still override the file correctly; no precedence regression was found.
I am adding the reproduction to the existing inline thread. Separately, Node 24 CI stops at vp check because this file is unformatted, so tests/coverage/build/generation did not execute in that job. Format the corrected implementation and rerun those gates. The two integration checks are green.
Jamie-BitFlight
left a comment
Jamie-BitFlight
left a comment
There was a problem hiding this comment.
Post-merge verification of df9882e17062e8805cc6072f7f78f4eacf5867b1 and main 40c9efd1eec677f6bf024402459661741330233a.
The original unknown-section compatibility finding is corrected: the guard now accepts unknown string names and the existing dispatcher still ignores them. This is separate from the remaining formatting failure attached inline. That failure persisted through merge and now affects both open follow-ups #729 and #730.
A focused formatting-only correction on main, followed by incorporating it into the open branches and rerunning their gates, is needed. Do not reintroduce the closed list of allowed section names while addressing this.
## [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))
|
🎉 This PR is included in version 2.0.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
1 participant
Validate the runtime shape and supported names of configured README sections before iterating them, rather than trusting an unchecked
ReadmeSection[]assertion. This is a deliberate tightening: previously unknown section names were ignored by the dispatcher. Draft pending compatibility review, malformed-config tests, and CI. Related #670.