Skip to content

Commit

Permalink
Add readmes to all implementation crates specifying that they do no o…
Browse files Browse the repository at this point in the history 
…ffer stable interfaces (#2320)
  • Loading branch information
@mamcx
mamcx authored Mar 6, 2025
1 parent 66b10dd commit f9f3854
Show file tree
Hide file tree
Showing 30 changed files with 85 additions and 0 deletions.
1 change: 1 addition & 0 deletions crates/bench/Cargo.toml
View file
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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.

2 comments on commit f9f3854

@github-actions
Copy link

@github-actions github-actions bot commented on f9f3854 Mar 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Criterion benchmark results

Error when comparing benchmarks: Couldn't find AWS credentials in environment, credentials file, or IAM role.

Caused by:
Couldn't find AWS credentials in environment, credentials file, or IAM role.

@github-actions
Copy link

@github-actions github-actions bot commented on f9f3854 Mar 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Callgrind benchmark results Error when comparing benchmarks: Couldn't find AWS credentials in environment, credentials file, or IAM role.

Caused by:
Couldn't find AWS credentials in environment, credentials file, or IAM role.

Please sign in to comment.