Skip to content

Versioning policy and docs - #3292

Merged
texodus merged 2 commits into
masterfrom
version-docs
Nov 17, 2026
Merged

texodus merged 2 commits into
masterfrom
version-docs

Conversation

@texodus

@texodus texodus commented Nov 17, 2026

Copy link
Copy Markdown
Member

This PR updates Perspective's version policy and add this policy prominently to the docs (for human and agent consumers). Exact match releases are always compatible, a patch difference produces a warning, and a different minor or major is an error. This is narrower npm and Cargo ranges between Perspective packages than previously, and new registry behavior when two Perspective versions share a page.

  • perspective-migrate
    • A config from a newer patch of the migrator's own major.minor passes through unmigrated, with a new Notice::NewerPatch { pointer, version }, and keeps its original version.
    • A newer minor or major still fails with FromFuture.
    • MigrateNotice in TS gains the new variant.
  • Page registry
    • Copies of Perspective with the same major.minor now share one registry and log a console.warn when their versions differ.
    • A different minor still throws in init().
  • <perspective-viewer>
    • restore(), restoreWorkspace() and addPanel() no longer add a "saved by" note to errors for configs from the same minor.
    • For configs from a newer release, the note no longer suggests perspective-migrate.
  • PerspectiveWidget
    • The widget treats version stamps with the same major.minor as equal, so a patch difference no longer forces an extra restore.
    • .devN is now stripped from the version in one place.
  • Dependency ranges
    • Published npm dependencies between Perspective packages change from ^ to ~. @perspective-dev/client pins @perspective-dev/server exactly.
    • Rust crate dependencies between Perspective crates change to ~x.y.z, and version.mjs writes ~ on each bump.
  • perspective_client::Version is new, with a same_minor() method. It moved from perspective-migrate, which re-exports it.
  • Docs: a new guide page, versioning.md

@texodus texodus added the enhancement Feature requests or improvements label Nov 17, 2026
Signed-off-by: Andrew Stein <steinlink@gmail.com>
@texodus
texodus force-pushed the version-docs branch 2 times, most recently from bbeab5c to 6a2efad Compare November 17, 2026 19:21
Signed-off-by: Andrew Stein <steinlink@gmail.com>
@texodus
texodus merged commit 989fc44 into master Nov 17, 2026
19 checks passed
@texodus
texodus deleted the version-docs branch November 17, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Feature requests or improvements

Development

Successfully merging this pull request may close these issues.

1 participant