docs(audiobook-curator): inventory --report and convert --receipt are optional since #734; test both paths - #738
Conversation
…on; test both paths (#725 follow-up)
🦋 Changeset detectedLatest commit: b3e8441 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
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. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b8a9e0f674
ℹ️ 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".
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "agent-bundle": patch | |||
There was a problem hiding this comment.
Remove the unrelated agent-bundle changeset
This commit changes only the private examples/audiobook-curator package, its tests, and documentation, so naming agent-bundle here will cause the release workflow to issue an unnecessary package version bump and changelog entry for behavior that the published package did not change. Private examples and the website are explicitly ignored and must not be named in a changeset, so this changeset should be deleted.
AGENTS.md reference: AGENTS.md:L159-L164
Useful? React with 👍 / 👎.
Follow-up to #734 (#725) from owner review.
The migration prose claimed required fields were unchanged. They were not: the retired
src/cli/inventory.tsxrequired--reportandsrc/cli/convert.tsxrequired--receipt; the<tool>.cli.tsprojections share the tools' optional fields. This PR documents that accurately and pins the behavior with tests. It does not restore duplicate handlers and does not make optional MCP fields required.Changes
website/docs/{en,zh}/examples/audiobook-curator.mdx,examples/audiobook-curator/README.md: state the behavior change (optional; no file written when omitted; exit codes,--applygating, error output unchanged)..changeset/725-receipt-paths-optional.md(patch).examples/audiobook-curator/tests/route-unit/cli-dispatch.test.ts:inventorywithout--report: exit 0, same receipt as the tool'sstructuredContent, no report file (the existing with---reporttest stays).audible-select(deterministic applied operation over a checked-in candidate report) with and without--receipt: identical result modulogeneratedAt, equals the MCP tool result, receipt file written only when asked, directory contains exactly the candidate report and the receipt.convertwith--receiptreaches the same domain validation exit 1 as without it,--yesremains unknown (confirm: false), and no receipt is written on failure.Local gate (branch contains
origin/main@ 4036e89)Deslop: Claude, 1 edit.
Self-review (Sol Max, run 1 — 4 findings, all fixed; run 2 below)
convert --apply(it writes the M4B). Fixed: "write no report or receipt file" in en/zh docs, README, changeset.library.withReceipt.stderrequalsplanned.stderrexactly.Run 2: one finding — the pre-existing sentence "a command that gets one still writes the receipt file" was unqualified while the convert test proves no receipt on failure; now "… when it succeeds" (en/zh/README). Run 3 not needed for a one-clause wording change.