Skip to content

Add readmes to all implementation crates specifying that they do no offer stable interfaces #2320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Centril merged 3 commits into from
Mar 6, 2025
Merged

Add readmes to all implementation crates specifying that they do no offer stable interfaces #2320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69c6e87
Add readmes to all implementation crates specifying that they do not …
mamcx Feb 25, 2025
d9359db
Addressing PR comments
mamcx Feb 28, 2025
8907471
Remove `unstable` comment for `bindings-sys`
mamcx Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/bench/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version.workspace = true
edition.workspace = true
license-file = "LICENSE"
description = "Bench library/utility for SpacetimeDB"
publish = false

[[bench]]
name = "special"
Expand Down
5 changes: 5 additions & 0 deletions crates/bench/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# spacetimedb-bench

> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.

Benchmarking suite for SpacetimeDB using [Criterion](https://github.com/bheisler/criterion.rs) and [Callgrind](https://valgrind.org/docs/manual/cl-manual.html) (via [iai-callgrind](https://github.com/clockworklabs/iai-callgrind)). Provides comparisons between the underlying spacetime datastore, spacetime modules, and sqlite.

To run the criterion benchmarks:
Expand Down
3 changes: 3 additions & 0 deletions crates/client-api-messages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Unstable Crate** ⚠️
>
> The interface of this crate is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/client-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/commitlog/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Unstable Crate** ⚠️
>
> The interface of this crate is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/data-structures/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/durability/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/execution/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/expr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/fs-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Unstable Crate** ⚠️
>
> The interface of this crate is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/paths/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/physical-plan/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/primitives/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/sats/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/snapshot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
1 change: 1 addition & 0 deletions crates/sqltest/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version.workspace = true
edition.workspace = true
description = "Sql integration test for SpacetimeDB"
license-file = "LICENSE"
publish = false

[dependencies]
spacetimedb-lib.workspace = true
Expand Down
4 changes: 4 additions & 0 deletions crates/sqltest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
This crate check the conformance of SpacetimeDB to SQL:2016

> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.

# Setup PG

Create a database called `TestSpace`
Expand Down
3 changes: 3 additions & 0 deletions crates/standalone/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Unstable Crate** ⚠️
>
> The interface of this crate is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/subscription/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Unstable Crate** ⚠️
>
> The interface of this crate is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
1 change: 1 addition & 0 deletions crates/testing/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "spacetimedb-testing"
version.workspace = true
edition.workspace = true
license-file = "LICENSE"
publish = false

[dependencies]
spacetimedb-cli.workspace = true
Expand Down
3 changes: 3 additions & 0 deletions crates/testing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
1 change: 1 addition & 0 deletions crates/update/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version.workspace = true
edition.workspace = true
rust-version.workspace = true
license-file = "LICENSE"
publish = false

[dependencies]
spacetimedb-paths.workspace = true
Expand Down
3 changes: 3 additions & 0 deletions crates/update/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
3 changes: 3 additions & 0 deletions crates/vm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> ⚠️ **Internal Crate** ⚠️
>
> This crate is intended for internal use only. It is **not** stable and may change without notice.
Loading