Skip to content

docs: versioning policy (option A) #250

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
ronaldtse merged 1 commit into from
Oct 6, 2026
Merged

docs: versioning policy (option A) #250

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
22 changes: 22 additions & 0 deletions docs/VERSIONING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Versioning policy — the three runtimes

The three runtime packages (npm `interscript`, RubyGems `interscript`,
PyPI `interscript`) version **independently**. There is no cross-registry
version alignment, and none is planned: the compatibility contract is
NOT the package version — it is

1. the **pinned index release** (`models-index.yaml` at tag index-vN,
printed by each release's notes and asserted by an exact-pin test in
every runtime), and
2. the **golden corpus** (cross-runtime byte-parity vectors; a runtime
whose output diverges does not release).

Package versions move on their own registries' conventions (the npm
line is long and mature; the gem entered its 3.x unified generation;
PyPI debuts after the trusted-publisher fix). Users who need a specific
behavior pin the index (`SECRYST_INDEX`/`INTERSCRIPT_ML_INDEX` env var
or the explicit `index_url`), not the package version.

Rule of thumb for releases: an index bump (new models, URL changes) is
a patch/minor per runtime; a dispatch-surface or contract change is a
minor per runtime; only user-facing breaking API changes take majors.
Loading