Road to 1.0

Every published crate is 0.x and not production-ready. This page gives the exit criteria for ergo-sbe and ergo-aeron-cluster: criteria, not a date.

ergo-sbe (reaches 1.0 first)

Ship a 1.0.0 of ergo-sbe only when all of the following hold:

1. API freeze audit complete — decisions in API freeze are stable; no pending renames of generated stage / wrap / FixedFields surface without a major.
2. Parity gate — every maintained ergon vs sbe-tool comparison passes the benchmark gate in both LTO profiles for three consecutive releases, with the gate output attached to each release. Ceilings and the inconclusive rule: sbe/BENCHMARKS.md.
3. Wire compatibility — dual-encode parity tests and golden API shape remain green; no deliberate wire break without a major.
4. Trust boundary — fuzz corpus on decode entry stays green in CI; Miri fixtures for unaligned paths stay green; no known P0 safety issues open.
5. Docs — book chapters for migration (sbe-tool), trust boundaries, buffer sizing, and type-state design notes are published and linked from the crate README.
6. External signal — at least one external user (or production pilot) has reported wire + latency results against their own schema, or an equivalent published case study in the repo.

Until then the disclaimer stays, but it points here instead of reading as a permanent warning.

ergo-aeron-cluster (separate clock)

Cluster 1.0 is not tied to sbe 1.0. Additional criteria (illustrative):

• Stable session lifecycle and error types under multi-node test harness
• Documented Aeron version matrix and rusteron compatibility
• Codec generation locked to a released ergo-sbe major
• Separate performance gate (just bench-cluster) with recorded baselines

Cluster may remain 0.x after sbe 1.0.

What 1.0 is not

• Not “feature complete for every SBE edge case in every venue schema”
• Not a promise that your schema’s latency matches the car/L3 benches
• Not a freeze of optional config knobs’ defaults without changelog

Tracking

• Release process: Verification & Release.
• Changelog: repository root CHANGELOG.md.
• External pilot: External Schema Pilot.
• Cluster compatibility: Cluster Compatibility.
• API baseline manifest: api/public-api-baseline.toml. scripts/check-public-api.sh runs cargo-semver-checks on each published crate it lists (ergo-aeron-cluster only with CLUSTER_SEMVER_CHECKS=1; a crate first published after the baseline once the baseline reaches that release). scripts/check-generated-public-api.sh diffs generated codec surfaces against api/generated/*.txt.
• Benchmark evidence: just bench + just bench-cluster write provenance-stamped Criterion trees; scripts/package-bench-artifacts.sh attaches them to a GitHub release. A number without a matching run-id / HEAD commit is not evidence.

Status

A claimed 1.0 streak tag must be an ancestor of main (git merge-base --is-ancestor <tag> main), not merely a GitHub Release. git describe --tags is not the check.

1.0 API migrations (still 1.0-only)

These remain scheduled for 1.0 and are not shipped on 0.x. cargo semver-checks against the v0.1.26 baseline (the baseline_tag in api/public-api-baseline.toml) must stay green.

• Schema identity as one private Ir (no duplicate public package/id/version beside ir). 0.x keeps the public fields.
• XML deprecated as Option<u16> through Encoding, FieldInfo, and ItemContext. 0.x keeps deprecated: bool on those public types.
• Removal of GenerationConfig::with_error_from_impls. 0.x keeps the deprecated helper; prefer a typed From<generated::sbe_rt::{EncodeError, DecodeError}> so needed/available survive ?.

Shipped on this 0.x line:

• ergo-aeron-cluster has no test-harness feature. Repository Java launch support is ergo-aeron-cluster-test-harness.