chore(api): mark new exported packages experimental before v1.3.0 (#6036)
Maintainer decision D-7: the ~52k-line exported Go surface added since v1.2.2 should not freeze as a v1 compatibility commitment at the 1.3.0 tag. backend/ and backend/conformance/ already carried a Stability section; this adds the matching disclaimer to the other new root-level exported packages. Doc comments only, no behavior change. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
parent
5bd0db1877
commit
9884b3dd33
6 changed files with 34 additions and 0 deletions
|
|
@ -26,6 +26,12 @@
|
|||
//
|
||||
// The package imports stdlib and nothing else, and it must stay that way: it
|
||||
// sits beneath every leaf, so anything it imports is imported by all of them.
|
||||
//
|
||||
// # Stability
|
||||
//
|
||||
// EXPERIMENTAL. This package is not yet covered by the project's compatibility
|
||||
// promise and may change in a minor release. Every leaf re-exports from here,
|
||||
// so a change to this vocabulary reaches all of them at once.
|
||||
package beadserrors
|
||||
|
||||
import (
|
||||
|
|
|
|||
|
|
@ -1,4 +1,9 @@
|
|||
// Package issueops declares the public values used for guarded issue mutations.
|
||||
//
|
||||
// # Stability
|
||||
//
|
||||
// EXPERIMENTAL. This package is not yet covered by the project's compatibility
|
||||
// promise and may change in a minor release. Pin an exact beads version.
|
||||
package issueops
|
||||
|
||||
import (
|
||||
|
|
|
|||
|
|
@ -64,4 +64,10 @@
|
|||
// matches by identity. If a validation refusal ever appears here it aliases
|
||||
// beadserrors.ErrValidation rather than minting a twin, for the reasons
|
||||
// memoryops/errors.go gives.
|
||||
//
|
||||
// # Stability
|
||||
//
|
||||
// EXPERIMENTAL. This package is not yet covered by the project's compatibility
|
||||
// promise and may change in a minor release. A consumer replaying the feed
|
||||
// should pin an exact beads version.
|
||||
package journalops
|
||||
|
|
|
|||
|
|
@ -45,4 +45,9 @@
|
|||
// cursor. A front door that prints them sorts the keys, and both do today. If
|
||||
// this plane ever grows to thousands of rows, a paged reader is a new role
|
||||
// conversation and not a retrofit of this one.
|
||||
//
|
||||
// # Stability
|
||||
//
|
||||
// EXPERIMENTAL. This package is not yet covered by the project's compatibility
|
||||
// promise and may change in a minor release. Pin an exact beads version.
|
||||
package memoryops
|
||||
|
|
|
|||
|
|
@ -1,6 +1,12 @@
|
|||
// Package schema is the public wrapper around bd's schema migration engine,
|
||||
// re-exporting the minimal surface external tools need to create or upgrade a
|
||||
// beads database over a standard database/sql connection.
|
||||
//
|
||||
// # Stability
|
||||
//
|
||||
// EXPERIMENTAL. This package is not yet covered by the project's compatibility
|
||||
// promise and may change in a minor release. The migration set it wraps grows
|
||||
// every release; pin an exact beads version.
|
||||
package schema
|
||||
|
||||
import (
|
||||
|
|
|
|||
|
|
@ -8,6 +8,12 @@
|
|||
// isolated workspace for each backend. Adding a backend is one Profiles entry; the
|
||||
// runner and scripts/conformance.sh pick it up automatically. The suite is behind
|
||||
// the `e2e` build tag because it shells out to a freshly built bd.
|
||||
//
|
||||
// # Stability
|
||||
//
|
||||
// EXPERIMENTAL, same terms as the backend package: this harness tracks the
|
||||
// evolving storage contract and its registry may change in a minor release.
|
||||
// Pin an exact beads version.
|
||||
package conformance
|
||||
|
||||
// Workspace is one isolated place a backend can be `bd init`-ed. Dir is the working
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue