Skip to content

docs(audiobook-curator): inventory --report and convert --receipt are optional since #734; test both paths - #738

Merged
ScriptedAlchemy merged 4 commits into
mainfrom
fix/725-receipt-followup
Sep 7, 2026
Merged

docs(audiobook-curator): inventory --report and convert --receipt are optional since #734; test both paths#738
ScriptedAlchemy merged 4 commits into
mainfrom
fix/725-receipt-followup

Conversation

@ScriptedAlchemy

@ScriptedAlchemy ScriptedAlchemy commented Sep 7, 2026

Copy link
Copy Markdown
Owner

Follow-up to #734 (#725) from owner review.

The migration prose claimed required fields were unchanged. They were not: the retired src/cli/inventory.tsx required --report and src/cli/convert.tsx required --receipt; the <tool>.cli.ts projections 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, --apply gating, error output unchanged).
  • .changeset/725-receipt-paths-optional.md (patch).
  • examples/audiobook-curator/tests/route-unit/cli-dispatch.test.ts:
    • inventory without --report: exit 0, same receipt as the tool's structuredContent, no report file (the existing with---report test stays).
    • audible-select (deterministic applied operation over a checked-in candidate report) with and without --receipt: identical result modulo generatedAt, equals the MCP tool result, receipt file written only when asked, directory contains exactly the candidate report and the receipt.
    • convert with --receipt reaches the same domain validation exit 1 as without it, --yes remains unknown (confirm: false), and no receipt is written on failure.

Local gate (branch contains origin/main @ 4036e89)

pnpm build && pnpm typecheck && pnpm lint      # ok
examples/audiobook-curator: pnpm test:routes    # 34 passed (32 before)
pnpm test:unit                                 # 4468 passed
pnpm docs:site:build                           # ok, 0 broken links

Deslop: Claude, 1 edit.

Self-review (Sol Max, run 1 — 4 findings, all fixed; run 2 below)

  1. Docs said commands "write no file" when the receipt path is omitted, which misreads for convert --apply (it writes the M4B). Fixed: "write no report or receipt file" in en/zh docs, README, changeset.
  2. Inventory-without-report test checked one arbitrary path; now asserts the temp directory holds only library.
  3. Audible-select test asserted receipt absence only after the with-receipt run; now asserts directory contents right after the without-receipt run.
  4. Convert-with-receipt test used a substring; now withReceipt.stderr equals planned.stderr exactly.

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.

@changeset-bot

changeset-bot Bot commented Sep 7, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: b3e8441

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

This PR includes changesets to release 1 package
Name Type
agent-bundle 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

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 7, 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-09-07T07:12:20.713240Z b8a9e0f PR opened
ℹ️ 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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge 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 👍 / 👎.

@ScriptedAlchemy
ScriptedAlchemy merged commit 2dffc46 into main Sep 7, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant