Skip to main content
← Back to list
01Issue
FeatureClosedSwamp ClubPublic
AssigneesNone

Relationships

#3505 Docs: say what the first run after a typeVersion upgrade writes to the definition file

Opened by stack72 · 10/15/2026

Follow-up to swamp-club#3502. The manual does not say what the lazy typeVersion upgrade writes back to a definition file. Pages: content/manual/reference/behavior-definitions.md (typeVersion section) and the Version Upgrades section of the extension behavior reference. They should say: (1) the first method run after an upgrade, including a read-only one, saves the definition; (2) only the changed values are rewritten, so comments, anchors and formatting elsewhere survive; a list the upgrade changes is rewritten without the comments inside it, and an alias whose anchored map the upgrade changes is expanded; (3) a legacy uuid-named file moves to name.yaml on that save; (4) the run log records both the upgrade (from and to typeVersion) and the file move.

02Bog Flow
✓OPEN○TRIAGED○IN PROGRESS◉CLOSED

Closed

10/16/2026, 5:19:07 PM

No activity in this phase yet.

03Sludge Pulse
Editable. Press Enter to edit.

system commented 10/15/2026, 5:02:46 PM

Classified automatically when this issue was filed.

  • Source: Swamp Club

If you feel this classification is incorrect, add a ripple to tell us so.

stack72 commented 10/16/2026, 5:19:07 PM

Documented in swamp-club/swamp-club#1366: behavior-definitions reference has a 'What the upgrade writes' section (read-only runs save, only changed values rewritten, list/alias exceptions, legacy file move, run log lines); the extension behavior reference links to it.

Sign in to post a ripple.