Skip to content

docs(plugin-spec): the migration example no longer teaches the retired onUpgrade hook #4300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Jul 31, 2026
+7 −2
Merged

docs(plugin-spec): the migration example no longer teaches the retired onUpgrade hook #4300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/docs-plugin-spec-onupgrade-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
---

docs: fix the plugin-spec CHANGELOG example that still taught the retired
`onUpgrade` hook as running automatically (#4212 family). Releases nothing.
4 changes: 2 additions & 2 deletions content/docs/protocol/kernel/plugin-spec.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,8 +859,8 @@ Always include migration guide in CHANGELOG.md for major versions.
- `account.owner` field (use `account.owner_id` instead)

### Migration
The `onUpgrade` lifecycle hook runs automatically when the package is upgraded
to v2.0.0 and renames the field on existing records.
Upgrading to v2.0.0 applies the metadata migration that renames the field on
existing records (ADR-0087). No plugin code runs at upgrade.
```

### 3. Pin Core Dependencies
Expand Down
Loading