AVELUNE

Versioning and compatibility

The draft software-version and format-generation axes, intended stable-release policy, and required updates for format-breaking changes.

View source
Documentation navigation

Use

  1. CLI guide

Browser

  1. Browser streaming contract
  2. WebGPU and browser acceleration — Draft Generation 1

Architecture

  1. Codec direction (non-normative)

Development

  1. Independent conformance oracle
  2. Testing Avelune
  3. Avelune document authoring profile
  4. Versioning and compatibility
  5. Avelune web style
  6. Release checklist

Project

  1. IPR / prior-art notes — Draft Generation 1

History

  1. Historical internal Avelune “1.0.0” snapshot (superseded)
On this page
  1. Current status
  2. Separate version axes
  3. Intended stable-line policy
  4. Draft format-breaking changes

Current status

Avelune currently has no stable codec, container, or public API. The public software tree uses 0.x versions until the project intentionally declares a stable compatibility line.

Separate version axes

Two version axes are deliberately separate:

  1. Software version — Cargo crates, CLI, web player, and tooling. During 0.x, incompatible API changes may occur in a minor release.

  2. Format generation — identifiers such as ALV1 and ALA1. “1” currently means Draft Generation 1; it does not mean that the format has been frozen or promised permanent compatibility.

Intended stable-line policy

Once a stable major line is declared, the intended policy is:

  • patch: compatible fixes only;

  • minor: compatible features and encoder improvements; existing valid streams remain decodable;

  • major: incompatible public API, codec/container syntax, or decoded-semantics change.

A new stable major may replace the previous one or coexist with it. Long-term maintenance of old major lines will be decided explicitly rather than promised in advance.

Draft format-breaking changes

Until stabilization, format-breaking changes must update the spec, conformance vectors, decoder(s), CLI/docs, and changelog together. Do not preserve draft compatibility merely because an earlier POC happened to emit that syntax.