instar 0.9.8 → 0.9.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/upgrades/0.9.9.md +34 -0
package/package.json
CHANGED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Upgrade Guide: Instar (latest)
|
|
2
|
+
|
|
3
|
+
## What Changed
|
|
4
|
+
|
|
5
|
+
### Upgrade Guide Enforcement — Every Release Now Tells Its Story
|
|
6
|
+
|
|
7
|
+
Previously, most releases shipped silently — you'd just see "Updated to vX.Y.Z. Restarting." with no context about what changed. Only major version bumps required upgrade guides, so patch releases (which is most releases) provided zero information.
|
|
8
|
+
|
|
9
|
+
Now **every single release** must include an upgrade guide before it can be published. The CI pipeline blocks any publish that doesn't include `upgrades/NEXT.md` — a human-readable story about what changed, what it means for you, and what to tell your user.
|
|
10
|
+
|
|
11
|
+
This means you'll always know what just happened when you update. No more silent upgrades.
|
|
12
|
+
|
|
13
|
+
### Upgrade Guide Processor Fix — No More Stale Feature Announcements
|
|
14
|
+
|
|
15
|
+
Previously, when you updated across multiple versions (e.g., 0.9.2 → 0.9.5), the upgrade processor would concatenate ALL historical guides — not just the ones for versions you hadn't seen. This caused upgrade announcements that repeated old features alongside new ones.
|
|
16
|
+
|
|
17
|
+
Now the processor filters by your previous version. If you were on 0.9.3 and update to 0.9.5, you only see guides for 0.9.4 and 0.9.5 — not everything back to the beginning.
|
|
18
|
+
|
|
19
|
+
### DRY Hook Templates
|
|
20
|
+
|
|
21
|
+
Session-start and compaction-recovery hook templates are now maintained in one canonical location (`PostUpdateMigrator.getHookContent()`) instead of being duplicated between `init.ts` and `PostUpdateMigrator.ts`. This is an internal change — your hooks work the same way, but future updates to hook behavior will be more consistent.
|
|
22
|
+
|
|
23
|
+
## What to Tell Your User
|
|
24
|
+
|
|
25
|
+
- **Better update notifications**: "From now on, every time I update, I'll actually know what changed and can tell you about it. No more generic 'just updated' messages — I'll explain what's new and what it means for you."
|
|
26
|
+
- **Cleaner upgrade announcements**: "I fixed an issue where update announcements would sometimes repeat features from older versions. Now I only report what's actually new."
|
|
27
|
+
|
|
28
|
+
## Summary of New Capabilities
|
|
29
|
+
|
|
30
|
+
| Capability | How to Use |
|
|
31
|
+
|-----------|-----------|
|
|
32
|
+
| Mandatory upgrade guides | Automatic — every release now includes context about what changed |
|
|
33
|
+
| Version-filtered upgrade processor | Automatic — only shows guides for versions newer than your previous version |
|
|
34
|
+
| NEXT.md convention | When contributing changes, write `upgrades/NEXT.md` describing what changed |
|