Documentation
¶
Overview ¶
Package stability classifies every package in the module into a support tier and enforces, via [TestEveryPackageIsClassified], that no package ships without an explicit classification.
The tiers below are the machine-readable half of the policy documented in framework/docs/content/stability.md and docs/public-api.md. The human docs explain what each tier promises; this file is the source of truth for which package is in which tier, and the test package is the gate that keeps the two in sync.
Before v1.0.0 the supported library surface is Provisional, not Stable: it is documented and follows the deprecation window in stability.md, but it is not frozen. Promoting a package to Stable is the deliberate v1 act — it is not done implicitly by omission.
Index ¶
Constants ¶
const ModulePath = "github.com/DonaldMurillo/gofastr"
ModulePath is the module's import path. Package paths in the manifest are written relative to it (leading slash dropped), e.g. "framework/crud".
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Tier ¶
type Tier string
Tier is a package's support classification.
const ( // Stable: frozen public API. After v1.0.0 a breaking change requires a // new major version. No package is Stable before v1.0.0 — the freeze is // an explicit release act, never a default. Stable Tier = "stable" // Provisional: supported and documented, but may change before v1.0.0 // following the deprecation window in stability.md. This is the honest // pre-v1 tier for the framework, core, core-ui, and battery surface. Provisional Tier = "provisional" // Experimental: may change or be removed without a deprecation window. // Consumers should pin a version. Covers framework/experimental/*, the // Kiln build-mode runtime, and the codegen extension exec surface. Experimental Tier = "experimental" // Internal: not a public contract even though the symbols are exported. // Import at your own risk; these move freely. Internal Tier = "internal" // Excluded: not part of the shipped library surface at all — examples, // benchmarks, evals, and build output. Present so the coverage gate can // account for every package rather than silently skipping some. Excluded Tier = "excluded" )