canopycms 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -5,9 +5,9 @@ packages release together, at one version.
 
 ## This build
 
-Version `0.6.0`, built from [`83be4af`](https://github.com/safeinsights/canopycms/tree/83be4af22312c30e8b89a5f14a7eb51d2af2944e).
+Version `0.7.0`, built from [`628670d`](https://github.com/safeinsights/canopycms/tree/628670db4d927cf37c1a5037467a0fa10f1f06b0).
 
-Its entries are [0.6.0](#060), under **Released**.
+Its entries are [0.7.0](#070), under **Released**.
 
 If you upgraded from a build on another branch, compare the `<!-- changeset: … -->` slugs in your previous build's `CHANGELOG.md` (`npm pack canopycms@<old>` fetches it) with this one's: entries whose slug your old file lacks are new to you.
 
@@ -24,7 +24,7 @@ Each entry has up to three parts:
 `node_modules/canopycms/CHANGELOG.md`, assembled for that build: its **This build** section lists
 what is new since the previous int on the same branch, or on a stable release links its entries, and its links point at the commit the build
 came from. The copy in the repository holds released history and the entries from before changesets;
-every entry written since is a file in [`.changeset/`](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/.changeset/README.md) until a stable release
+every entry written since is a file in [`.changeset/`](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/.changeset/README.md) until a stable release
 moves it here.
 
 **Find your starting point.** From a stable pin, start at the first version under **Released**
@@ -62,6 +62,127 @@ entries under **Released**.
 
 ## Released
 
+### 0.7.0
+
+<!-- changeset: playwright-1-64-ubuntu-26-04 -->
+
+#### The editor opens on the deployment's own default branch — **breaking (client config)**
+
+<!-- changeset: editor-starts-on-server-branch -->
+
+_First in 0.7.0._
+
+**What changed.** `/edit` with no `?branch=` now opens on the branch the server names as its
+default: `defaultActiveBranch`, else the base branch, as that deployment resolves them. Before,
+it opened on the branch the config evaluated in the browser named. In the browser a value read
+from an environment variable falls back to its literal, so a deployment whose base differs from
+that literal opened on the wrong branch. `config.client()` and `CanopyClientConfig` no longer
+carry `defaultBaseBranch` or `defaultActiveBranch`, and `CanopyEditor` without a `branchName`
+starts branchless and adopts the server's default, as `CanopyEditorPage` does. If the branch
+list fails to load, both panes say so and the form offers Retry.
+
+**To adopt.** Nothing, unless your code reads `config.client().defaultBaseBranch` or
+`.defaultActiveBranch`. Read the branch from the server config instead (`config.server`, on the
+server), or from the branches API's `defaultBranch` in the browser. To open the editor on a
+particular branch, link to `/edit?branch=<name>`.
+
+**Now deletable.** A `NEXT_PUBLIC_` copy of the base-branch variable, or an `/edit` link that adds
+`?branch=` only to work around the editor opening on the wrong branch.
+
+#### Pull request bodies show the editor's open comments
+
+<!-- changeset: pr-body-comment-state -->
+
+_First in 0.7.0._
+
+**What changed.** The pull request a submit opens now lists the branch's unresolved editor comment threads: where each one is, the first line of its first comment (80 characters at most) and a link to it in the editor. Once every thread is resolved, it says so. The list is updated whenever a comment is added, replied to or resolved, as well as on submit. Comment excerpts are visible to everyone who can read the pull request, which on a public repository means everyone. Open threads do not block the merge or keep the pull request in draft. A pull request opened before this release shows no list until its branch is next submitted.
+
+**To adopt.** Nothing, if your deploy replaces the worker along with the CMS, as `cdk deploy` of the canopycms-cdk stack does with the default `workerCode`. A worker on an earlier release fails each update of the list and marks the branch's sync failed until a later task succeeds, so a pipeline that leaves the worker behind must roll it no later than the CMS: see [Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#rolling-the-worker-from-ci).
+
+#### Pull request bodies link back to the editor
+
+<!-- changeset: pr-body-editor-links -->
+
+_First in 0.7.0._
+
+**What changed.** The pull request a submit opens links to the branch in the editor, and each changed entry to that entry. A notice tells reviewers that comments on the pull request do not reach the editor, so the author will not see them. The links use the editor's URL from the submit, accepted only when its host is the one the request was addressed to (`X-Forwarded-Host`, else `Host`), which holds behind `canopycms-cdk`'s CloudFront distribution as it stands.
+
+**To adopt.** Nothing, unless a proxy in front of the CMS sets neither header to the editor's public host: then set `editorUrl` in your Canopy config to the editor page's URL, e.g. `editorUrl: 'https://cms.example.org/edit'`. See [the config reference](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#definecanopyconfig-options).
+
+#### CloudFront origin read timeout accepted up to 120 s; the editor waits 135 s
+
+<!-- changeset: cdk-origin-read-timeout-120 -->
+
+_First in 0.7.0._
+
+**What changed.** `CanopyCmsDistribution` and `attachTo` accepted an origin read timeout of at most 60 s, but CloudFront's default quota for "Response timeout per origin" is 120 s. Both now accept up to 120 s and refuse more at synth, with an error that names the quota. A raised quota does not lift the limit, because the editor's request deadline is set just above it: the standard deadline is now 135 s and a branch create's is 150 s, so a standard request that never answers shows its timeout message after 135 s rather than 75 s. Long requests, such as submit, admin scans and an upload the CMS proxies, still wait 180 s.
+
+**To adopt.** Nothing is required; the default Lambda timeout is still 60 s. To allow slower requests, pass `timeout: Duration.seconds(120)` (at most) to `CanopyCmsService` and `originReadTimeout: cmsService.timeout` to `CanopyCmsDistribution`.
+
+#### Approve and Request changes in the editor
+
+<!-- changeset: review-approve-request-changes -->
+
+_First in 0.7.0._
+
+**What changed.** Reviewers and admins can now Approve a submitted branch, and Request changes with an optional note, from the top bar and the branch card. The branch's creator never gets them, and a reviewer on the branch's access list finds them only in the branch card's menu. Approve is a CanopyCMS status and does not approve the pull request on GitHub, which stays open for someone with access to merge. Request changes also works on an approved branch. It converts the pull request to a draft, and its note is saved as a comment on the branch.
+
+#### Markdown typed in "Edit source" saves in Prettier's markers
+
+<!-- changeset: source-mode-markdown-export-style -->
+
+_First in 0.7.0._
+
+**What changed.** A markdown body typed in a markdown field's "Edit source" mode used to be written as typed, so `*italic*` and `*` bullets failed a required `prettier --check`. A save now restyles every new or edited block in place to Prettier's style: `-` bullets, `_` emphasis, `**` strong, `---` rules, `#` headings, backtick fences, padded tables, and one blank line between blocks. This applies whichever editor mode produced the block, and to a new entry's body. Only markers and whitespace change, plus an escaped `_` between two letters, which Prettier also unescapes. Text, links, entities and other escapes stay as typed. Untouched blocks keep their bytes, and a block is restyled only if it still means exactly what was typed. Cases Prettier still flags are listed in [#1116](https://github.com/safeinsights/canopycms/issues/1116).
+
+#### Fix the App links `init-github-app create` prints for an organisation
+
+<!-- changeset: init-github-app-org-links -->
+
+_First in 0.7.0._
+
+**What changed.** For an organisation-owned repository, `canopycms init-github-app create` printed App settings and install links under `github.com/settings/apps/…`, which 404 for an organisation's App. It now prints the `github.com/organizations/<owner>/settings/apps/…` form; user-owned repositories are unchanged. The command's output is also laid out for scanning, with bold headings, a permissions list, green ticks for progress and red crosses for failures, and is plain text on a stream that is piped (unless `FORCE_COLOR` turns colour on) or when `NO_COLOR` is set.
+
+#### Faster first request to a new editor deployment
+
+<!-- changeset: settings-workspace-first-clone -->
+
+_First in 0.7.0._
+
+**What changed.** A new deployment's first request builds the settings workspace without
+writing the base branch's files into it, so it no longer spends an EFS write and a delete on
+every file of the site, and cold starts arriving together share that one build. If the process building it dies, the others
+build their own after waiting at most 15 seconds. The `provision dir=settings` log line gives the
+time each step took.
+
+#### Live preview shows a list reference's picks on load
+
+<!-- changeset: preview-list-reference-targets -->
+
+_First in 0.7.0._
+
+**What changed.** The editor loads an entry with its references resolved, so a `list: true`
+reference arrives as its targets. Live preview used to hand the view `null` for each of them until
+the list was edited; it now passes each loaded target through, as it already did for a single
+reference.
+
+#### The worker keeps syncing past one corrupt branch on git 2.56 and later
+
+<!-- changeset: worker-fetch-past-a-corrupt-branch -->
+
+_First in 0.7.0._
+
+**What changed.** From git 2.56, `git bundle unbundle` fails when any branch in `remote.git` has a
+corrupt object in its history. Because the worker used it for every GitHub fetch, one torn
+object on the shared filesystem would have failed every sync cycle until an operator repaired the
+repository. The worker now checks that each prerequisite of the bundle is a commit and indexes
+the pack itself, so the sync skips only the damaged branch, as it did on git 2.55. Three kinds of
+damage still stop every fetch, as they did on 2.55: a corrupt object in `remote.git` that the
+incoming pack also carries, a prerequisite whose object header is torn, and a corrupt commit in
+a branch's first-parent history, which the fetch walks to tell GitHub what `remote.git` already
+has before the first fetch has written its tracking refs
+([#1104](https://github.com/safeinsights/canopycms/issues/1104)).
+
 ### 0.6.0
 
 #### Clerk organizations-as-groups is a deployment setting, and survives a Clerk instance without Organizations — **behaviour change**
@@ -72,7 +193,7 @@ _First in 0.6.0._
 
 **What changed.** `CanopyCmsService` takes `clerkOrganizationsAsGroups` (default `true`, unchanged), which the worker honours; in a deployment it, not the plugin's `useOrganizationsAsGroups`, decides the groups. When Clerk refuses the organization list with a 403 (Organizations disabled), the refresh now writes users with no groups and logs a warning, instead of failing whole; any other failure still keeps the last snapshot. Memberships are fetched instance-wide rather than per user. The scaffolds write `false` explicitly: `useOrganizationsAsGroups` in `canopycms init`'s `canopy.ts`, and `clerkOrganizationsAsGroups` in `canopycms init-deploy aws`'s CDK stack.
 
-**To adopt.** On a Clerk instance without Organizations, set `clerkOrganizationsAsGroups: false` on `CanopyCmsService` and `useOrganizationsAsGroups: false` in `createClerkAuthPlugin`. See [Deploying to AWS](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md).
+**To adopt.** On a Clerk instance without Organizations, set `clerkOrganizationsAsGroups: false` on `CanopyCmsService` and `useOrganizationsAsGroups: false` in `createClerkAuthPlugin`. See [Deploying to AWS](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md).
 
 ### 0.5.0
 
@@ -84,7 +205,7 @@ _First in 0.5.0._
 
 **What changed.** A `type: 'reference', list: true` field now edits as rows in stored order, like an `object` list: drag a row or use its "…" menu to move or remove it, open a row to swap its entry in place, and pick from Add under the rows to append. Neither control offers an entry the list already holds. Any `list: true` field, and any `block` field, takes `maxItems`. The editor stops adding at the cap and says why, a save over it is refused, and a production build fails on an entry over it, naming the entry, field, count and cap. Adding `maxItems` to a list that already holds more therefore fails the build until an editor removes the extra items. `maxItems` on a field that holds no items is refused when the entry schema registry is created.
 
-**To adopt.** Set `maxItems: 3` on the list field in its entry schema. See [Field Types](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#field-types).
+**To adopt.** Set `maxItems: 3` on the list field in its entry schema. See [Field Types](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#field-types).
 
 #### SEO field location moves into config; reference pickers mark hidden entries and take a sort order — **breaking: `createNextCanopyContext({ seo })` and `AIContentConfig.seo` are removed**
 
@@ -94,7 +215,7 @@ _First in 0.5.0._
 
 **What changed.** `defineCanopyConfig` takes `seo: { group?, fields? }`, the one place every surface reads an entry's `noindex` flag: the sitemap and `entryToMetadata` that `createNextCanopyContext` returns, AI content and the editor's reference picker. A per-call `seo`/`group`/`fields` still overrides it. The free `generateContentSitemap` takes `seo` as an argument and refuses to run without it when the config sets one; `createNextCanopyContext` and the AI content config refuse a leftover `seo`. A reference picker now badges an entry hidden from search as "Hidden from search", and picking one adds a note naming the setting on that entry's form, since a page listing only indexed entries won't show it. A reference field takes `optionSort`: `'label'` (the default), `'collection'`, or `{ field, direction }`. Point `field` at an ISO date, since strings compare as text.
 
-**To adopt.** Move `seo` from `createNextCanopyContext({ seo })` and from `defineAIContentConfig({ seo })` into `defineCanopyConfig({ seo })`. See [Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#sitemap-and-seo-metadata) and [How References Work in the Editor](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#how-references-work-in-the-editor).
+**To adopt.** Move `seo` from `createNextCanopyContext({ seo })` and from `defineAIContentConfig({ seo })` into `defineCanopyConfig({ seo })`. See [Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#sitemap-and-seo-metadata) and [How References Work in the Editor](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#how-references-work-in-the-editor).
 
 **Now deletable.** A shared `seo` constant passed separately to the Next context and the AI content config.
 
@@ -122,7 +243,7 @@ resolved without it.
 **To adopt.** Where a reference renders its target's prose, set `includeBody: true` on that
 reference field. Code that reads the body from a link-only reference's resolved type now sees
 `string | undefined`; either set `includeBody: true` or handle the missing value. See
-[Resolving References in a Listing](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#resolving-references-in-a-listing).
+[Resolving References in a Listing](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#resolving-references-in-a-listing).
 
 ### 0.3.3
 
@@ -194,7 +315,7 @@ button: Save all is the button, and its caret holds Submit or Withdraw. A branch
 action draws no caret. The confirm dialog returns focus to the review action, and focus follows
 that action when a submit or withdraw moves it between the caret and a button of its own.
 
-#### The branch bar states a locked branch's status, replacing the lock banner — **behaviour change**
+#### The branch bar states a locked branch's status, replacing the lock banner — **breaking (operatingStrategy().supportsStatusBadge removed) / behaviour change**
 
 <!-- changeset: branch-bar-status -->
 
@@ -212,7 +333,13 @@ protected base branch; Withdraw from review on a branch in review; Refresh branc
 failed to load; and Switch branch… otherwise. Below the `md` breakpoint a locked branch has no
 Save all: its way forward leads, with Submit or Withdraw in its caret unless Withdraw is that way.
 Someone who may not withdraw gets Switch branch…, with the blocked Withdraw and its reason in the
-caret.
+caret. The status badge's feature flag goes with the pill's badge: `supportsStatusBadge()` is
+removed from `ClientSafeStrategy`, so the strategy that `operatingStrategy(mode)` returns from
+`canopycms/server` no longer has it.
+
+**To adopt.** Where you call `operatingStrategy(mode).supportsStatusBadge()`, drop the call. It
+is a type error, or a `TypeError` at run time without type checking. The editor shows the status
+itself now.
 
 #### The content panel lists unsaved entries under a Changed filter, replacing the pill's list — **behaviour change**
 
@@ -533,7 +660,7 @@ URL.
 2. For a branch preview: wrap views with `withCanopyPreview` in a `'use client'` module, add
    `app/preview/[[...path]]/page.server.tsx`, set `editor.previewPrefix: '/preview'`, and serve that
    route with `frame-ancestors 'self'`, not `X-Frame-Options: DENY` (see
-   [Live Preview](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#live-preview)).
+   [Live Preview](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#live-preview)).
 3. A test reading view content from the route's server HTML must load the page in a browser.
    Server output rendered during a preview request carries the signed-in asset prefix; keep it out
    of cross-request caches (`unstable_cache`, module memos).
@@ -548,7 +675,7 @@ kept site styles ahead of Mantine's in the preview.
 server components. A string path marks the form's spelling (`'a.0.b'` marks `a[0].b`), and an empty
 path marks nothing. The editor counts and logs marks naming no field. `createEntrySchemaRegistry`
 refuses a field name that is empty, all digits or contains `.`, `[` or `]`. See
-[Live Preview](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#live-preview).
+[Live Preview](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#live-preview).
 
 **To adopt.** Fix each path that stops compiling; the error lists valid ones. Rewrite computed paths
 as literal segments, or type that component's prop as plain `FieldProps`. Pass `fieldProps` as
@@ -630,7 +757,7 @@ or a failed render) renders as its plain text, with no URL; any other form of th
 fields are nested or renamed, pass the AI config's `seo` the same object you pass
 `createNextCanopyContext({ seo })`, so the sitemap and AI content read the flag from the same
 place. A field that links to a hidden section by plain URL needs a field transform; the README
-shows [the recipe](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#ai-content-configuration).
+shows [the recipe](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#ai-content-configuration).
 
 **Now deletable.** An `exclude.where` that re-read the `noindex` flag by hand.
 
@@ -652,7 +779,7 @@ A `markdown` field with `renderAs: 'mdx'` is checked as MDX, and `mdxAllow` narr
 field or site-wide. New: field options `renderAs`, `mdxAllow`; config key `mdxAllow`; type
 `MdxAllowlist`. (int.110) A component prop allowance can be `'string'` (or
 `{ type: 'string', maxLength }`): a quoted value only, never bare or `{…}`. See
-[MDX content cannot run code](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#mdx-content-cannot-run-code).
+[MDX content cannot run code](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#mdx-content-cannot-run-code).
 
 **To adopt.** Set `renderAs: 'mdx'` on each `markdown` field your site compiles as MDX, and
 `mdxAllow` to what your renderer takes. Set `executable: true` only on a field whose editors you
@@ -789,7 +916,7 @@ a format check.
 
 - (int.93) Submit commits gain an `Edited-by: Name (id)` trailer; PR bodies gain a section that
   re-submits replace, keeping human text. Options: `gitEditedByTrailers`, `gitCoAuthoredByTrailers`
-  ([reference](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#definecanopyconfig-options)).
+  ([reference](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#definecanopyconfig-options)).
 - (int.110) Submit-commit trailers name every user who saved since the last submit commit, and
   the PR-body section every user who edited the branch, not only the submitter; settings commits
   (permissions, groups) carry the acting user's trailer.
@@ -813,7 +940,7 @@ saves only push the branch, and no failing PR task lands in System health.
 that entry type goes unavailable: the editor says so, and its entries answer 503 with
 `code: 'SCHEMA_UNAVAILABLE'`. Builds, static deploys and `generate-ai-content` still fail. The
 worker holds the base branch for up to 30 minutes while that lasts; see
-[New schemas wait for the editor deploy](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#new-schemas-wait-for-the-editor-deploy).
+[New schemas wait for the editor deploy](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#new-schemas-wait-for-the-editor-deploy).
 Public types gain optional `unavailable` on `EntryTypeConfig` and `FlatSchemaItem`, optional
 `ApiResponse.code`, and a required `SchemaResolutionResult.issues`.
 
@@ -851,7 +978,7 @@ hang until the drain heartbeat lets termination continue. Its in-flight task is
 new stack needs no steps.
 
 **What changed.** (int.109) Detailed in
-[The worker instance](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#the-worker-instance): IMDSv2 with a hop limit of 1; the
+[The worker instance](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#the-worker-instance): IMDSv2 with a hop limit of 1; the
 bundle is one file whose sha256 user data checks, readable as that one object; a file-system policy
 refusing clients without TLS or IAM, replacing the worker's
 `AmazonElasticFileSystemClientReadWriteAccess`; an encrypted gp3 root volume; a boot-time upgrade to
@@ -905,10 +1032,10 @@ failure and exits non-zero on `selfStopped`, with a code outside `RestartPrevent
   with its hash, as `worker/dist/index.js` and `index.js.sha256`. The default, `'asset'`, is
   unchanged.
 - `CanopyCmsService` alarms when the worker logs no git sync for 30 minutes. See
-  [Worker-down alarm](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#worker-down-alarm).
+  [Worker-down alarm](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#worker-down-alarm).
 
 **To adopt.** Optional. For parameter-only change sets, see
-[Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#rolling-the-worker-from-ci). For the alarm, pass
+[Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#rolling-the-worker-from-ci). For the alarm, pass
 `alarmTopic`.
 
 **Now deletable.** A manual `cdk deploy` after each canopycms bump whose only purpose is moving the
@@ -919,7 +1046,7 @@ worker, and a hand-built alarm on the worker log group.
 **What changed.** (int.112) The boot's `dnf upgrade` could be OOM-killed on every retry. A 1 GiB
 swap file now goes on first; an upgrade that still fails starts the worker unpatched and notifies
 `alarmTopic` if set; a retried step names itself when it gives up. See
-[The worker instance](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#the-worker-instance).
+[The worker instance](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#the-worker-instance).
 
 **To adopt.** Deploy, which replaces the worker instance. The bundle needs none of this, so it is
 not Template first and the worker contract stays at 1.
@@ -985,7 +1112,7 @@ and operations may reuse GitHub fetches under 30 seconds old.
 
 **To adopt.** Nothing. Seeding `remote.git` stages a copy of the repository beside the gateway's
 mirror, so the root volume needs room for two
-([details](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#the-worker-instance)).
+([details](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#the-worker-instance)).
 
 #### The worker follows a rebased or deleted GitHub branch
 
@@ -1007,7 +1134,7 @@ changes the template too (the fallback bundle's key and hash), so only the contr
 bundle-only roll is safe.
 
 **To adopt.** Parameter mode: gate bundle-only rolls on the contract
-([recipe](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#rolling-the-worker-from-ci)). The gate refuses a stack without the
+([recipe](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#rolling-the-worker-from-ci)). The gate refuses a stack without the
 `WorkerContract` output, so `cdk deploy` the template once, which adds it. A hand-installed unit
 copies its `Environment=CANOPYCMS_WORKER_CONTRACT=` line from `worker/canopy-worker.service`.
 
@@ -1024,8 +1151,8 @@ units from the bundle's contract: 2 gets the split, an older bundle the single u
 template, then roll the bundle; on an older template it stops with `template too old for this
 bundle`. Inspect EFS only through `sudo /opt/canopy-worker/canopy-inspect <command>`, never from a root shell. A hand install
 takes `worker/`'s three units and `gateway.env.example`
-([steps](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#installing-the-units-by-hand)). After the first deploy, run the
-[checklist](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#first-deploy-checklist).
+([steps](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#installing-the-units-by-hand)). After the first deploy, run the
+[checklist](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#first-deploy-checklist).
 
 #### `canopycms-cdk`: `CanopyCmsService.attachTo`, and editor response headers — **behaviour change if you frame the CMS**
 
@@ -1036,7 +1163,7 @@ response headers policy. `CanopyCmsDistribution` sends the same headers: `frame-
 `X-Frame-Options: SAMEORIGIN`, `nosniff`, HSTS and `X-Robots-Tag: noindex`. Unless your app sends
 its own framing headers, no other origin can frame the editor or any page the CMS domain serves. Every such page is
 marked `noindex`. The editor's default preview is same-origin and unaffected. See
-[Serving the editor from a distribution you already own](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#serving-the-editor-from-a-distribution-you-already-own).
+[Serving the editor from a distribution you already own](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#serving-the-editor-from-a-distribution-you-already-own).
 
 **To adopt.** If you wired the Function URL into your own distribution by hand, delete those
 behaviors and call `attachTo`, passing your CMS build's `assetPrefix` as `editorAssetPrefix` and a
@@ -1212,7 +1339,7 @@ one the exclusions leave out. A throw or any other return is logged and treated
 **To adopt.** If your site's routes, sitemap or bylines decide that some entries have no page,
 apply the same rule here, for example `referenceLink: (target, { body }) =>
 !body?.trim() ? false : undefined` in `defineAIContentConfig` from `canopycms/ai`. See
-[AI Content Configuration](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#ai-content-configuration).
+[AI Content Configuration](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#ai-content-configuration).
 
 **Now deletable.** A `fieldTransforms` entry that re-renders a reference field only to drop or
 change its link.
@@ -1287,7 +1414,7 @@ _First in int.115._
 entry the base branch also changed, the "updated on the base branch" notice and the branch's
 conflict count now stay until the branch merges, so a reviewer still sees which entries replaced a
 base change. They used to clear on the next sync, about five minutes later. README's new [Drafts
-and Unpublishing](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#drafts-and-unpublishing) section covers long-lived branches and
+and Unpublishing](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#drafts-and-unpublishing) section covers long-lived branches and
 unpublishing.
 
 #### The editor calls the content drawer "All content"
@@ -1599,7 +1726,7 @@ editor carries an unsaved draft of a stamped entry onto its stamped version.
 The flag is refused off a top-level `datetime`, on `list: true`, and with `required: true`.
 
 **To adopt.** Add `stampOnPublish: true` to the date field your site sorts or labels by, such as
-`{ name: 'publishedAt', type: 'datetime', stampOnPublish: true }`. See [Stamping a publication date](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#stamping-a-publication-date).
+`{ name: 'publishedAt', type: 'datetime', stampOnPublish: true }`. See [Stamping a publication date](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#stamping-a-publication-date).
 
 **Now deletable.** A build step or hook that writes a missing publication date into new entries.
 
@@ -1646,7 +1773,7 @@ preview/form divider is now keyboard-resizable within the same 15–85% the spli
 stored at, and `react-split-pane` is no longer a dependency.
 `EditorPanes`, `EditorPanesProps`, the `PaneLayout` type and the `SPLIT_PERCENT_*` and `DEFAULT_*_SPLIT_PERCENT` constants are
 no longer exported from `canopycms/client`. See
-[Your root layout](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#editor-customization).
+[Your root layout](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#editor-customization).
 
 **To adopt.** Nothing, unless you import `EditorPanes` or those constants: render `CanopyEditor`
 instead, which lays out its own panes. Hiding your site chrome on the editor route is now
@@ -1757,7 +1884,7 @@ never ended. `canopycms-auth-clerk` skips it while the editor is mounted, and ex
 **To adopt.** Nothing for the editor, if your edit page uses `useClerkAuthConfig()` or
 `ClerkSignIn`. If your CMS build renders `<SignIn>`, `UserButton` or `OrganizationSwitcher` on your
 own pages, mount the hook as in
-[Clerk components on your own pages](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/packages/canopycms-auth-clerk/README.md#clerk-components-on-your-own-pages).
+[Clerk components on your own pages](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/packages/canopycms-auth-clerk/README.md#clerk-components-on-your-own-pages).
 Your own Server Actions in the CMS build still 403 behind OAC.
 
 **Now deletable.** Any local patch of `window.__internal_onBeforeSetActive` (or 6.x's
@@ -1798,12 +1925,12 @@ fast naming the ARN, the field and the keys present, never a value.
 **To adopt.** Nothing, unless one of those secrets holds a JSON document: then set the matching
 prop. The scaffolded stack fills them from the repository _variables_
 `CANOPY_GITHUB_TOKEN_SECRET_JSON_FIELD` and `CLERK_SECRET_KEY_SECRET_JSON_FIELD`
-([why the prefix](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#repository-secrets-and-variables)); a stack scaffolded earlier
+([why the prefix](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#repository-secrets-and-variables)); a stack scaffolded earlier
 adds the props to `infrastructure/bin/app.ts` and `infrastructure/lib/cms-stack.ts` and the two `env`
 lines to `.github/workflows/deploy-cms.yml`, or re-runs the generator and diffs. `cdk synth` refuses a `…JsonField` prop without its `…SecretArn`, and an ARN carrying the ECS `:KEY::` suffix
 (also in `secretsArns`). Don't use CDK's `secretValueFromJson`: it resolves the plaintext into the deployed
 resource's configuration, readable by anyone who can describe it. Only `CLERK_SECRET_KEY` goes through Secrets Manager; `CLERK_JWT_KEY` and the publishable
-key are public material ([Security Model](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#security-model)).
+key are public material ([Security Model](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#security-model)).
 
 **Now deletable.** A wrapper that fetches the secret, parses it and re-exports one field into the
 worker's environment, such as a `jq` step in user data or a wrapper entrypoint around
@@ -1815,7 +1942,7 @@ worker's environment, such as a `jq` step in user data or a wrapper entrypoint a
 `githubToken` is not deprecated and stays the documented default; `canopycms` neither depends on
 nor imports `@octokit/auth-app`. Register one App per site, not one shared across repositories:
 anyone holding an App's key can mint a token for any of its installations
-([why](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/ARCHITECTURE.md#why-one-github-app-per-site-not-one-shared-across-an-organisation)).
+([why](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/ARCHITECTURE.md#why-one-github-app-per-site-not-one-shared-across-an-organisation)).
 
 **To adopt with `canopycms-cdk`** (existing stacks need no edit). `CanopyCmsServiceProps` takes
 `githubAppId`, `githubAppInstallationId`, `githubAppPrivateKeySecretArn` and
@@ -1828,7 +1955,7 @@ anyone holding an App's key can mint a token for any of its installations
    `verify` checks an existing installation's permissions: run it, since an App missing a
    permission only shows up later, as `sync-failed`. `create` needs an interactive terminal and
    never edits an existing JSON secret (create one and point the JSON-field prop at it)
-   ([details](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#register-it-with-canopycms-init-github-app)).
+   ([details](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#register-it-with-canopycms-init-github-app)).
 2. Set the three props and **remove `githubTokenSecretArn`** (with its JSON field). A partial set
    of the three is refused at synth, and so is an App alongside a token.
 3. In the generated workflow, store them as `CANOPY_GITHUB_APP_ID`,
@@ -1839,7 +1966,7 @@ anyone holding an App's key can mint a token for any of its installations
 
 The private key is ARN-only; passing the key itself is refused at synth. Its ARN joins the worker's
 IAM policy automatically, so you need not add it to `secretsArns`. See
-[Authenticating as a GitHub App](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#authenticating-as-a-github-app).
+[Authenticating as a GitHub App](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#authenticating-as-a-github-app).
 
 ```bash
 canopycms init-github-app create -- \
@@ -1887,7 +2014,7 @@ downloads the `.pem` from the App's settings page.
 
 **What changed.** The worker re-reads a Secrets Manager secret (the GitHub token or the Clerk secret
 key) when the operation using it fails. Timings, costs and the store-before-revoke order are in
-[Rotating a secret](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#rotating-a-secret).
+[Rotating a secret](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#rotating-a-secret).
 
 **To adopt.** Nothing for credentials from `*_SECRET_ARN`, which is every scaffolded deployment. A
 GitHub App private key is still read only at boot: store the new key, replace the instance, and
@@ -1941,12 +2068,12 @@ also check the bucket policy for its grant.
 5. `withCanopy()` adds sharp's libvips to Next's file tracing (not for a static export) and, on
    Next 16 and later, sets `turbopack: {}` when your config has neither `turbopack` nor your own
    `webpack` and it can read your Next version. A webpack build still fails its image transforms
-   ([Dual Build Support](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#dual-build-support)).
+   ([Dual Build Support](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#dual-build-support)).
 
 **Breaking:** a stack setting `platform` on `fromImageAsset` without `architecture` gets an arm64
 function while `platform` still decides the image, so `Platform.LINUX_AMD64` builds an image the
 function cannot run. A stack setting neither moves to arm64 with a matching image, built under QEMU
-on an x86 host ([Where the image is built](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#where-the-image-is-built)).
+on an x86 host ([Where the image is built](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#where-the-image-is-built)).
 
 **To adopt.**
 
@@ -1975,7 +2102,7 @@ reason; `platform` on `fromImageAsset`; and, with `withCanopy()`, a hand-written
 
 **What changed.** `media.uploadUrl` (s3 adapter; an absolute http(s) URL or a site-relative path)
 replaces the `url` that `beginUpload()` returns, leaving the presign's `fields` untouched, so
-uploads can be same-origin. See [Media Configuration](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#media-configuration) for the
+uploads can be same-origin. See [Media Configuration](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#media-configuration) for the
 CloudFront behavior it expects.
 
 **To adopt.** Optional. Set it from an environment variable: a site-relative value works only where
@@ -2000,7 +2127,7 @@ needs `lazyPublicTransforms: true`) let you pass a deterministically named role,
 bucket's stack computes `arn:aws:iam::<account>:role/<name>` from literals instead of a
 `Fn::GetStackOutput` reference only the CDK CLI resolves. The constructs re-attach
 `AWSLambdaBasicExecutionRole` (and the VPC policy) that `lambda.Function` drops from a role you
-pass. See [Cross-account asset bucket](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#cross-account-asset-bucket).
+pass. See [Cross-account asset bucket](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#cross-account-asset-bucket).
 
 **To adopt.** Optional:
 
@@ -2110,7 +2237,7 @@ public JWKS PEM, used only to verify signatures.
 to variables (Settings → Secrets and variables → Actions → Variables); `bin/app.ts` refuses the
 deploy at synth while it is unset. Check that `bin/app.ts` passes `CLERK_SECRET_KEY` as
 `clerkSecretKeySecretArn` (read by the worker), never in the Lambda's `environment`, unless you keep
-`clerkMiddleware` ([Security Model](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/docs/deploying-to-aws.md#security-model)).
+`clerkMiddleware` ([Security Model](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/docs/deploying-to-aws.md#security-model)).
 
 #### `readByUrlPath` answers only where `listEntries` publishes — **breaking (routing)**
 
@@ -2209,7 +2336,7 @@ basePath: process.env.NEXT_PUBLIC_BASE_PATH,
 Then pass `baseUrl` to `assetUrl` only if Next serves `/assets` (local adapter, `next dev`, S3 with
 no distribution): `assetUrl(image, { width: 960, baseUrl: BASE_PATH })`. Assets on CloudFront via
 `AssetSupport` stay at the distribution root; pass no `baseUrl` (mount table under "Where `/assets`
-is mounted" in [Media Configuration](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#media-configuration)). Two traps:
+is mounted" in [Media Configuration](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#media-configuration)). Two traps:
 
 - Don't pass a deployment `basePath` to `contentStaticParams({ basePath })`; that option filters by
   a nested route prefix and emits zero params, building green.
@@ -2368,7 +2495,7 @@ Under `exactOptionalPropertyTypes: true`, omit keys instead of assigning `undefi
 `withTrailingSlash` and `isAbsoluteUrl` from `canopycms/server`; `defineSeoFieldGroup()` from
 `canopycms`; `generateContentSitemap` and `entryToMetadata` from `canopycms-next`, bound on
 `createNextCanopyContext`'s result. See
-[Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#sitemap-and-seo-metadata). Every routable entry type is in
+[Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#sitemap-and-seo-metadata). Every routable entry type is in
 the sitemap unless `exclude`d or `noindex`; one `noindex` predicate drives both robots metadata and
 sitemap exclusion. `trailingSlash` is never inferred. `lastModified` defaults to `updatedAt`, a
 filesystem mtime. An empty SEO field counts as unset. `siteUrl` must be absolute, colliding URLs are
@@ -2425,7 +2552,7 @@ underscore-prefixed files are skipped.
 
 **What changed.** New scaffolds write `defaultBranchAccess: 'deny'` and
 `defaultPathAccess: { read: 'allow' }`
-([Public read on server deployments](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#public-read-on-server-deployments)).
+([Public read on server deployments](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#public-read-on-server-deployments)).
 
 **To adopt.** An older scaffold's `defaultBranchAccess: 'allow'` is wider than recommended;
 consider `'deny'`. If you deleted `defaultPathAccess: { read: 'allow' }`, anonymous visitors get no content until you
@@ -2478,7 +2605,7 @@ re-checked an entry's type (a `switch` on `meta.entryType` can merge them into o
 **What changed.** `BlockComponentRegistry<Blocks>` (types only, from `canopycms`; `BlockValueOf<Blocks, 'hero'>`
 gives one template's value type) requires exactly
 one component per block template name when written as an object literal. See
-[Block Component Registries](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#block-component-registries) and
+[Block Component Registries](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#block-component-registries) and
 `apps/example1/app/components/PostView.tsx`.
 
 ```ts
@@ -2500,7 +2627,7 @@ templates against the schema.
 
 **What changed.** Spreading a `const` field array into several schemas, and nesting
 `defineInlineFieldGroup()` inside a block template, are documented
-([Reusable Field Fragments](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#reusable-field-fragments)); `defineFieldFragment()` is an
+([Reusable Field Fragments](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#reusable-field-fragments)); `defineFieldFragment()` is an
 identity helper for them.
 
 ```ts
@@ -2519,7 +2646,7 @@ field by composing from the same `const` field object.
 A block template holding a `reference` field is a shared block; `read()`/`readByUrlPath()` resolve
 it, and listings do with
 [`resolveReferences`](#listings-resolve-references-and-a-resolved-reference-carries-urlpath-and-optionally-its-body-16--breaking-type-level)
-(0.0.64). See [Shared / Referenced Blocks](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#shared--referenced-blocks).
+(0.0.64). See [Shared / Referenced Blocks](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#shared--referenced-blocks).
 
 **Now deletable.** A second `read()` in page code to unwrap a shared block's reference.
 
@@ -2541,7 +2668,7 @@ Not retro-documented, apart from these:
 
 #### The registry is keyed by entry-type name (0.0.42)
 
-**What changed.** `createEntrySchemaRegistry` keys are the entry-type names that `.collection.json` files name in `entry.schema`, and `EntryTypesFromRegistry` derives the typed entry-type map from them. Schema-variable keys (`{ postSchema }`) still work but derive nothing; [README's registry convention](https://github.com/safeinsights/canopycms/blob/83be4af22312c30e8b89a5f14a7eb51d2af2944e/README.md#convention-why-key-the-registry-by-entry-type-name) says when to keep them.
+**What changed.** `createEntrySchemaRegistry` keys are the entry-type names that `.collection.json` files name in `entry.schema`, and `EntryTypesFromRegistry` derives the typed entry-type map from them. Schema-variable keys (`{ postSchema }`) still work but derive nothing; [README's registry convention](https://github.com/safeinsights/canopycms/blob/628670db4d927cf37c1a5037467a0fa10f1f06b0/README.md#convention-why-key-the-registry-by-entry-type-name) says when to keep them.
 
 **To adopt.**
 

package/dist/api/branch-review.d.ts

@@ -1,5 +1,9 @@
 import { z } from 'zod';
 import { type BranchListItemResponse } from './branch.js';
+export interface RequestChangesBody {
+    /** Saved as a branch comment; trimmed before its length is checked, and ignored when empty. */
+    note?: string;
+}
 export declare const requestChanges: import("./route-builder.js").RouteDefinition<z.ZodObject<{
     branch: z.ZodType<import("../paths/index.js").BranchName, z.ZodTypeDef, import("../paths/index.js").BranchName>;
 }, "strip", z.ZodTypeAny, {
@@ -10,7 +14,13 @@ export declare const requestChanges: import("./route-builder.js").RouteDefinitio
     branch: string & {
         readonly __brand: "BranchName";
     };
-}>, undefined, BranchListItemResponse>;
+}>, z.ZodOptional<z.ZodObject<{
+    note: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    note?: string | undefined;
+}, {
+    note?: string | undefined;
+}>>, BranchListItemResponse>;
 export declare const approveBranch: import("./route-builder.js").RouteDefinition<z.ZodObject<{
     branch: z.ZodType<import("../paths/index.js").BranchName, z.ZodTypeDef, import("../paths/index.js").BranchName>;
 }, "strip", z.ZodTypeAny, {