Skip to content

Versioning Policy

HiveFlow follows Semantic Versioning 2.0.0 while in Alpha (0.y.z).

Current status: 0.1.x Alpha

  • 0.1.x — Initial public releases; API may change between minors with migration notes in CHANGELOG.
  • 0.2.x — Developer experience focus: unified high-level API, OpenTelemetry docs, coverage targets.
  • 1.0.0 — API freeze after Core + Studio stable for 6 months (Roadmap).

What counts as breaking

Change Bump
Remove/rename public hiveflow exports Minor during 0.x (documented); Major at 1.0+
Studio REST path or payload change Minor + migration note
Default env behavior change Minor + CHANGELOG
Internal module refactor Patch

Packages

PyPI name Scope
hiveflow Core engine
hiveflow-agent Agent runtime (depends on hiveflow-core>=0.1)

Version numbers are kept in sync for releases (v0.1.0 tag publishes both).

Quality gates (0.1.x)

Package Coverage (CI) Notes
hiveflow ≥ 60% MyPy on public API surface; PyPI Alpha classifier
hiveflow-agent ≥ 60% Real LLM tests optional locally (-m real_llm)
Studio backend ≥ 60% Monorepo / Docker only
Studio frontend ≥ 24% lines Pages via Playwright E2E

Details: Quality Gates.

Upgrade checklist

  1. Read CHANGELOG.
  2. Run your test suite and examples/run_smoke_tests.py.
  3. For Studio: check Studio Agent Operations env vars.