docs(client): drop the retired validateOnly batch option from the README (#4052) - #4443
Merged
Conversation
…DME (#4052) The README still promised `validateOnly` as a working dry-run, but the key was retired in #4052 precisely because no batch surface ever read it — a caller sending it to preview a mutation got it executed. Point readers at the upgrade-guide tombstone instead of re-documenting a flag that lies. Evaluated under objectstack#4372 (write-path validate-only mode): closed as not planned — no current consumer justifies the surface. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016zx2NHsRkFzpKoefPEWZxD
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
Contributor
📓 Docs Drift CheckThis PR changes 1 package(s): 13 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
|
github-actions
Bot
added
the
documentation
The Check Changeset gate requires an explicit declaration, and this one is a real patch rather than release-nothing: README.md is in @objectstack/client's `files`, so the corrected text only reaches npmjs.com readers if it ships. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016zx2NHsRkFzpKoefPEWZxD
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
问题
packages/client/README.md的 Batch Options 一节至今仍把validateOnly文档化为可用的 dry-run:这个 key 在 #4052 已经退役,
BatchOptionsSchema里是retiredKey(...)墓碑。退役的理由恰恰是它从未被实现——批量写入面(updateManyData/deleteManyData/batchData)一律照常落库,调用方发validateOnly: true想预览一次变更,拿到的是真的执行了。README 继续承诺它可用,是同一个「declared ≠ enforced」(PD #10)的文档版本:读 README 的调用方会写下一个数据安全保证,而那个保证不存在。改动
删掉那一行,替换为指向墓碑的说明,措辞与
docs/protocol-upgrade-guide.md的batch-options-validate-only-retired条目一致:>
validateOnlywas retired in #4052 — it was never implemented and batch surfaces persisted> regardless, so there is no batch dry-run today. Drop the key; see
>
docs/protocol-upgrade-guide.md(batch-options-validate-only-retired).Batch Options 列表其余三项(
atomic/returnRecords/continueOnError)不动。背景
这处不一致是在评估 #4372(写路径 validate-only / dry-run 模式)时发现的。该 issue 已按产品评估关闭为 not planned——没有当前消费者,而没有消费者的写路径 data-safety flag 正是 #4052 的失败模式。既然结论是「今天没有 dry-run」,文档就不该继续说有。
范围与验证
纯文档改动,无代码、无 spec、无生成物变更。
带
@objectstack/client: patchchangeset,而不是「releases nothing」的空 changeset:README.md在本包package.json的files里,随包发布——改对的文字只有在包发布后才真正送达受影响的读者(npmjs.com 上读 README 的调用方)。仓内既有的空 changeset 先例都是 ADR / 设计文档这类不随包发布的东西,与此不同。验证方式:复核 diff 仅涉及目标行,以及新文案与 upgrade-guide、
batch.zod.ts墓碑三处措辞一致。🤖 Generated with Claude Code
https://claude.ai/code/session_016zx2NHsRkFzpKoefPEWZxD
Generated by Claude Code