You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 834546b
Browse filesBrowse the repository at this point in the historyBrowse files
docs(releases): the 18.1.0 notes, and the 18.x level rule on every page that still promised strict SemVer after GA
- content/docs/releases/v18/18-1.mdx (new): the 18.1.0 notes, compiled from
the 18.1.0 changesets on main before the cut, grouped by what the reader
must do (73 manual, 9 converted, 41 new, 0 semantic, 104 fixes), with the
Console pins and an upgrade checklist from 18.0.0. Marked not walked.
- Upgrading: the "Upgrading to 18.0" section carried three post-18.0.0
behaviours with no version (#25155, #25179, #25231); they now say 18.1.0.
The per-release table gains 18.1.0, and the "a minor has nothing for
os migrate meta to replay" sentence admits 18.1.0's nine step-18 entries.
- Backward Compatibility, the releases index and the v18 index: after
18.0.0 the level follows the metadata protocol (#25105, ruling A), so a
breaking change ships in a minor or a patch; the pages said strict SemVer
resumed at GA and that a patch changes no behaviour.
- 18-0.mdx: a caret range takes later 18.x releases that can break; section
4 points at the 18.1.0 notes.
Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01At7xrR4rgknXtej5ZkMJHd
**The 17.x minors ran under a launch-window override: a breaking change shipped as a MINOR release, not a MAJOR one.** Every published `@objectstack/*` package versions in lockstep, so the version number alone is not an upgrade-safety signal; read [Launch Window](#launch-window-minor-releases-can-contain-breaking-changes) at the end of this page before you upgrade across 17.x.
19
19
20
20
**The v18 line has exited prerelease mode.** While Changesets was in pre mode with the tag `next`, every release cut from `main` was the next `18.0.0-next.N` on npm's `next` tag, and `scripts/check-changeset-no-major.mjs` stood aside in pre mode, so a pull request could declare a major bump. Changesets has exited pre mode, so the line's GA version is `18.0.0`, which publishes to npm's `latest` tag, and the guard again fails a pull request that declares a `major` bump. See [how a breaking stage lands on the v18 line](/docs/releases/v18#how-a-breaking-stage-lands-on-this-line).
21
+
22
+
**After 18.0.0, a breaking change ships in a MINOR or a PATCH release.** The maintainer's 2026-10-21 ruling ([#25105](https://github.com/objectstack-ai/objectstack/issues/25105)) keeps the no-major guard and grades each change by the metadata protocol: a key, value or metadata type added, narrowed or given a new meaning takes MINOR, and every other change takes PATCH, breaking or not. A non-protocol breaking change (a REST response, a boot refusal, a CLI exit status, a removed runtime export) keeps its `**BREAKING**` banner and ships as a PATCH. 18.1.0, the first release under the rule, is a MINOR that carries 82 changesets declared breaking.
21
23
</Callout>
22
24
23
25
ObjectStack follows [Semantic Versioning 2.0.0](https://semver.org/) (`MAJOR.MINOR.PATCH`). The table below describes what each component means; which version a breaking change ships in depends on the line, as the callout above says.
24
26
25
27
| Version Component | When Incremented | Guarantee |
26
28
|:---|:---|:---|
27
29
|**MAJOR** (X.0.0) | Incompatible API changes | May contain breaking changes |
28
-
|**MINOR** (0.X.0) | New features — and, in the 17.x minors, breaking changes | Existing code may require migration; the [release notes](/docs/releases) lead with what broke |
29
-
|**PATCH** (0.0.X) | Bug fixes, backward-compatible | No behavior changes, only fixes|
30
+
|**MINOR** (0.X.0) | New features — and, in the 17.x minors, breaking changes; after 18.0.0, any change to the metadata protocol (added, narrowed or semantic)| Existing code may require migration; the [release notes](/docs/releases) lead with what broke |
31
+
|**PATCH** (0.0.X) | Bug fixes — and, after 18.0.0, every change that is not to the metadata protocol, breaking ones included | Before 18.0.0, no behavior changes. After it, a PATCH can break a REST client, a boot or a script: read its release notes|
30
32
31
33
### SemVer Guarantees
32
34
@@ -201,14 +203,14 @@ The convention was enforced rather than informal — `scripts/check-changeset-no
201
203
### What this means for an upgrade
202
204
203
205
-**Do not read a MINOR bump as safe to take unattended.** Read the [release notes](/docs/releases) for the version you are moving to: they lead with breaking changes and carry the migration steps.
204
-
-**Pin exact versions** instead of caret ranges if you cannot review each MINOR before it lands.
206
+
-**Pin exact versions** instead of caret ranges if you cannot review each MINOR before it lands, and after 18.0.0 each PATCH as well.
205
207
-**Diff your own metadata** across the upgrade with `os diff <before> <after> --breaking-only`.
206
208
207
209
MAJOR releases do still happen — 17.0.0 was cut precisely because its breaking density was too high to carry `^16.x` consumers across on a caret range, and the v18 line is the next one — but in the 17.x minors an individual breaking change did not, on its own, force one.
208
210
209
211
### When it stops applying
210
212
211
-
The tables and deprecation timeline above state this rule for the 17.x minors directly, beside what the v18 prerelease did. Classic SemVer — where a breaking change once again requires a MAJOR — is the settled form the project returns to once the launch window closes: the window closes at GA, and strict SemVer resumes from that point. **For the 17.x minors, this section was the operative rule wherever any part of this page disagreed.** For the `18.0.0-next.N` prereleases, the operative rule is [how a breaking stage lands on the v18 line](/docs/releases/v18#how-a-breaking-stage-lands-on-this-line).
213
+
The tables and deprecation timeline above state this rule for the 17.x minors directly, beside what the v18 prerelease did. Classic SemVer — where a breaking change once again requires a MAJOR — is the settled form the project returns to once the launch window closes. **It did not close at the 18.0.0 GA.** The 2026-10-21 ruling ([#25105](https://github.com/objectstack-ai/objectstack/issues/25105)) keeps the no-major guard on the v18 line and grades each change by the metadata protocol instead, so after 18.0.0 a breaking change ships in a MINOR when it narrows the metadata protocol and in a PATCH when it does not. **For the 17.x minors, this section was the operative rule wherever any part of this page disagreed.** For the `18.0.0-next.N` prereleases, the operative rule is [how a breaking stage lands on the v18 line](/docs/releases/v18#how-a-breaking-stage-lands-on-this-line). For the releases after 18.0.0, it is that ruling: read every release's notes, PATCH releases included, and pin exact versions.
0 commit comments