feat: publish sp1 to crates.io

DEVELOPMENT.md

@@ -27,3 +27,65 @@ To build docs locally, run the following commands in the top-level directory:
 cargo install mdbook  # Installs mdbook locally
 mdbook serve  # Serves the docs locally
 ```
+
+## Publishing
+
+SP1 crates are hosted on [crates.io](https://crates.io/search?q=sp1). This guide will walk you through the publication process.
+
+The goal of this to to end up with a Github release and crate version that are referencing the same commit.
+
+### Step 1: Update Cargo.toml versions
+
+In each individual crate, update the version to the new version you want to publish.
+
+For example, if the last version was `0.0.1`, and you want to publish `0.0.2`, you would replace
+`version = "0.0.1"` with `version = "0.0.2"` each of the `Cargo.toml` files. You can do this all at
+once using a find-and-replace tool, but be mindful of any other crates that might match the last version.
+
+### Step 2: Create a release
+
+Merge the `Cargo.toml` version changes into `dev`, and then into `main`, and then create a new release on GitHub as the new version.
+
+### Step 3: Update Cargo.toml paths
+
+To be able to publish the crates, you must change the relative paths in the `Cargo.toml` to the new version.
+
+For example, if we have this `Cargo.toml` file:
+
+```toml
+sp1-core = { path = "../core" }
+```
+
+You would change it to this:
+
+```toml
+sp1-core = "0.0.2"
+```
+
+It may error that it doesn't exist yet, but that's okay.
+
+You won't end up committing these changes, as it's best to leave them as relative paths for development.
+
+### Step 4: Publish
+
+To publish newer versions of these crates, you should use the [cargo-publish-workspace](https://crates.io/crates/cargo-publish-workspace-v2) tool:
+
+```bash
+cargo install cargo-publish-workspace-v2
+```
+
+If you don't have a [crates.io](https://crates.io) account, you should create one. Next, go to your [crates.io account tokens](https://crates.io/settings/tokens) and create a new token.
+
+Then set it as your `CARGO_REGISTRY_TOKEN` environment variable:
+
+```bash
+export CARGO_REGISTRY_TOKEN=<your-token>
+```
+
+Then run the `cargo publish-workspace` command from the root of the repository:
+
+```bash
+cargo publish-workspace --target-version <version> --token $CARGO_REGISTRY_TOKEN --crate-prefix '' -- --allow-dirty
+```
+
+This will go through each of the crates and publish them. Each time you run it, it will go through and verify them, so you can be sure that they are all published correctly.

cli/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "sp1-cli"
-version = "0.1.0"
+version = "0.0.0-test"
 edition = "2021"
+description = "SP1 is a performant, 100% open-source, contributor-friendly zkVM."
+readme = "../README.md"
+license = "MIT OR Apache-2.0"
 
 [build-dependencies]
 vergen = { version = "8", default-features = false, features = [

core/Cargo.toml

@@ -1,7 +1,11 @@
 [package]
-edition = "2021"
 name = "sp1-core"
-version = "0.1.0"
+version = "0.0.0-test"
+edition = "2021"
+description = "SP1 is a performant, 100% open-source, contributor-friendly zkVM."
+readme = "../README.md"
+license = "MIT OR Apache-2.0"
+
 
 [dependencies]
 bincode = "1.3.3"
@@ -28,7 +32,7 @@ p3-poseidon2 = { workspace = true }
 p3-symmetric = { workspace = true }
 p3-uni-stark = { workspace = true }
 p3-util = { workspace = true }
-rrs-lib = { git = "https://github.com/GregAC/rrs.git" }
+rrs_lib = { package = "rrs-succinct", version = "0.1.0" }
 sp1-derive = { path = "../derive" }
 sp1-primitives = { path = "../primitives" }
 

derive/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "sp1-derive"
-version = "0.1.0"
+version = "0.0.0-test"
 edition = "2021"
+description = "SP1 is a performant, 100% open-source, contributor-friendly zkVM."
+readme = "../README.md"
+license = "MIT OR Apache-2.0"
 
 [lib]
 proc-macro = true

eval/Cargo.toml

@@ -1,7 +1,9 @@
 [package]
 name = "sp1-eval"
-version = "0.1.0"
+version = "0.0.0-test"
 edition = "2021"
+publish = false
+
 
 [dependencies]
 sp1-core = { path = "../core" }