Stability

Alpha software: Beignet is experimental alpha software. The 0.0.x package line is for early evaluation, and APIs may change between releases while the framework settles.

Beignet is pre-1.0 and currently optimized for finding the right framework shape. The public APIs are intended to become stable, but names, package boundaries, generators, file conventions, and provider setup may still change between 0.0.x releases.

What to expect

• Patch releases may include breaking API changes while the framework is in alpha.
• The docs, CLI starter, and examples are the source of truth for the current recommended app shape.
• Changesets and release notes describe package changes, but they are not yet a compatibility guarantee.
• Prefer starting new apps from the current CLI starter instead of copying an older generated app forward by hand.

What is meant to settle first

The core concepts are expected to stay recognizable:

• Contracts define HTTP shape, validation, clients, and OpenAPI.
• Route groups and hooks compose HTTP concerns.
• Use cases own application workflows.
• Ports and providers keep infrastructure replaceable.
• Feature-first folders keep large apps navigable.

The exact API names, options, generated files, and provider wiring can still change as Beignet moves toward a stable release.

Upgrade posture

During alpha, upgrade intentionally:

1. Read the changesets for changed packages.
2. Run beignet doctor --strict.
3. Run beignet lint.
4. Run your app's tests and typecheck.
5. Compare generated starter conventions when a release changes app structure.

Use Packages and imports and the generated API reference to confirm current public exports. Use Migration notes for larger breaking changes that need more context than a package changelog entry.