Repository navigation
Commit 576afc1
docs(spec): the 17.4.0 entry no longer records the paid packages/rest follow-up as owed (#21014)
Fixes #18858
Clause-②: no
## What
`packages/spec/CHANGELOG.md`, inside the released `@objectstack/spec`
17.4.0 entry for 094b8fd, closed its `batch.maxBatchSize` note with "it
is owed to a follow-up in `packages/rest`" and anchored the quoted
docblock at `packages/rest/src/rest-server.ts:2071`. Both are false
today, and the first was already false when it was published:
- ec5db7b (PR #16942) paid that follow-up. It rewrote
`enforceBatchSize`'s docblock to call the cap embedder policy. It landed
2026-09-08T18:05Z, eleven hours after 094b8fd (06:54Z), and shipped in
`@objectstack/rest` 17.4.0, the same release as the note. The npm
registry's `time` field shows spec 17.4.0 published at
2026-09-09T03:57:51Z and rest 17.4.0 at 03:58:13Z.
- `:2071` was correct at 094b8fd and has drifted since. At `a5bce4088`
that line is JSDoc on `resolveRequestEnvironmentId`.
This PR amends that one entry in place. It uses the shape this file's
own errata already use (`*Erratum, DATE — … (Corrected after
publication, #N.)*`, six instances in this file). The closest is the
2026-09-18 batch-cap erratum on the same subject, which puts the line at
the end of the entry and says how many passages above it were corrected
in place:
1. The passage now anchors the quotation by symbol (the
`enforceBatchSize` docblock of `packages/rest/src/rest-server.ts`)
instead of by line number. Its last clause names ec5db7b as the
follow-up that was paid.
2. One dated erratum line closes the entry and quotes both old
phrasings.
No other sentence in the entry is touched. This PR has no changeset. The
`packages/*/CHANGELOG.md` row of the AGENTS.md Documentation Guardrails
says a factual error in a released entry is amended in place in a
docs-only PR. A changeset would compile the correction into a new
release note, which is the erratum-in-a-later-entry shape that row rules
out. The amended text reaches npm with the next `@objectstack/spec`
tarball.
## Evidence (measured on `a5bce4088`, this branch's base)
| Reading | Result |
|---|---|
| `grep -c "deployment policy" packages/rest/src/rest-server.ts` | 0.
Positive control `grep -c maxBatchSize` on the same file: 6. The
docblock now reads "⛔ It is NOT deployment policy", but a line break
splits that phrase, so the single-line grep cannot match it. Its text
was read directly as well. |
| `packages/rest/CHANGELOG.md` | `ec5db7b` occurs once, under `##
17.4.0` / `### Patch Changes` |
| npm tarballs `@objectstack/spec` 17.4.0 and 17.5.0 | the "owed to a
follow-up" sentence is in each `package/CHANGELOG.md` once, under `##
17.4.0` |
| npm tarballs `@objectstack/rest` 17.4.0 and 17.5.0 | the `ec5db7b`
entry is in each once, under `## 17.4.0` |
| `git show 094b8fd:packages/rest/src/rest-server.ts`, line 2071 | "The
cap is deployment policy — …", so the anchor was correct when it was
written |
## Gates (on `efea2a386e`, the final commit)
`node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack
--commands` derived 55 commands for this one path. 51 ran and exited 0.
They include `pnpm check:nul-bytes`, `pnpm check:issue-citations`, `pnpm
check:published-files`, `pnpm check:release-notes`, `pnpm
check:release-page-status` and `node
scripts/check-release-section-coverage.mjs --strict`. The `--ran`
reconciliation reads: 55 accounted for, 51 run, 4 NOT-MEASURED, 0 UNRUN.
NOT MEASURED (4): `check:dts-closure`, `check:dual-build-cjs-loads`,
`check:lean-entry-closure` and `check:sourcemap-no-sources-content`.
Each exited 3 with PREREQUISITE NOT MET. They read the `dist/` of every
workspace package, and this worktree has no workspace build. A CHANGELOG
prose edit changes no build input, and CI runs these gates over a fresh
build.
`check:issue-citations` passes, but `**/CHANGELOG.md` is one of its
declared deferred surfaces, so it did not judge the new `#18858`
citation. That citation was checked by hand: REST `GET /issues/18858`
answers 200, and the item is an issue, not a pull request.
## Acceptance notes
- The entry's bold lead ("really does describe itself as deployment
policy") and its "it exists verbatim in the REST server" are in the
present tense. They describe the tree 094b8fd landed on. Following the
card's scope, they stay as written, and the erratum line records that
the docblock was rewritten in the same release.
- The card cites the passage at `:3581`, read at `631dcbd4b`. At
`a5bce4088` it is at `:18471`, because later release sections were added
above it.
---
_Generated by [Claude
Code](https://claude.ai/code/session_01JAhu8u8QfBvRjVZDox7CP9)_
Co-authored-by: Claude <noreply@anthropic.com>1 parent d1f8ce8 commit 576afc1
1 file changed
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18468 | 18468 | | |
18469 | 18469 | | |
18470 | 18470 | | |
18471 | | - | |
| 18471 | + | |
18472 | 18472 | | |
18473 | 18473 | | |
| 18474 | + | |
| 18475 | + | |
18474 | 18476 | | |
18475 | 18477 | | |
18476 | 18478 | | |
| |||
0 commit comments