Skip to content

Commit af5db85

Browse files
authored
Merge pull request #58 from interscript/docs/index-channel
docs(distribution): shipped index channel — Release assets + sidecar, pinned runtimes
2 parents 9267c20 + ef7d3c5 commit af5db85

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

TODO.distribution/00-overview.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,24 @@ Ruby model cache → ~/.cache/interscript/<task>/<version>/model.onnx
5353

5454
Each channel serves a real audience. None is redundant.
5555

56+
## Model index channel (SHIPPED 2026-08-27)
57+
58+
`models.yaml` is published as a **GitHub Release asset** — never
59+
raw.githubusercontent.com, never a branch head:
60+
61+
- Tag shape: `index-vN` (monotonic, immutable in practice; add a tag
62+
protection rule for `index-v*`).
63+
- Assets per release: `models-index.yaml` + `models-index.yaml.sha256`.
64+
- Workflow: `release-index.yml` (fires on `index-v*` tag push or
65+
workflow_dispatch).
66+
- Runtimes pin
67+
`https://github.com/interscript/interscript-ml/releases/download/index-vN/models-index.yaml`
68+
and MUST verify the `.sha256` sidecar before parsing (all four
69+
crystals: interscript-ts 3.1.0, secryst-ts 0.2.0, secryst-py 0.1.2,
70+
secryst gem 1.0.1 — sidecar good/bad/missing covered by tests).
71+
- Adding a model: WO03 gate → merge entry → cut `index-vN+1`
72+
runtimes pick it up on their next pin bump.
73+
5674
## File index
5775

5876
- `00-overview.md` — this file

0 commit comments

Comments
 (0)