From 2d00096e3d806c086d10b9ff848e07ccfea26f74 Mon Sep 17 00:00:00 2001 From: ilitteri Date: Tue, 11 Nov 2025 01:19:24 -0300 Subject: [PATCH 1/4] Improve release process docs second step --- docs/developers/release-process.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/developers/release-process.md b/docs/developers/release-process.md index 6df87763c1c..f4c49decdd4 100644 --- a/docs/developers/release-process.md +++ b/docs/developers/release-process.md @@ -14,17 +14,24 @@ Examples: ## 2nd - Bump version -In the release branch, update the `[workspace.package]` version to `X.Y.Z` in the root `Cargo.toml`, and push the change to the branch. +The version must be updated to `X.Y.Z` in the release branch. There are multiple `Cargo.toml` and `Cargo.lock` files that need to be updated. -An example can be found here: +First, we need to update the version of the workspace package. You can find it in the `Cargo.toml` file in the root directory, under the `[workspace.package]` section. -https://github.com/lambdaclass/ethrex/pull/4881/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542 +Then, we need to update three more `Cargo.toml` files that are not part of the workspace but fulfill the role of packages in the monorepo. These are located in the following paths: -There are currently three `Cargo.lock` files that will be affected. Make sure you check them: +- `crates/l2/prover/src/guest_program/src/sp1/Cargo.toml` +- `crates/l2/prover/src/guest_program/src/risc0/Cargo.toml` +- `crates/l2/tee/quote-gen/Cargo.toml` -- root `Cargo.lock` -- `sp1/Cargo.lock` -- `risc0/Cargo.lock` +After updating the version in the `Cargo.toml` files, we need to update the `Cargo.lock` files to reflect the new versions. Run `cargo update` in their respective directories: + +- In the root directory +- `crates/l2/prover/src/guest_program/src/sp1` +- `crates/l2/prover/src/guest_program/src/risc0` +- `crates/l2/tee/quote-gen` + +An example of a PR that bumps the version can be found [here](https://github.com/lambdaclass/ethrex/pull/4881/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542). ## 3rd - Create & Push Tag From 6d6a6b3b6b5efe9123c8e26e35c344751ea21a2d Mon Sep 17 00:00:00 2001 From: ilitteri Date: Tue, 11 Nov 2025 09:57:29 -0300 Subject: [PATCH 2/4] Add step for committing the changes to the release branch --- docs/developers/release-process.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/developers/release-process.md b/docs/developers/release-process.md index f4c49decdd4..c80c389246c 100644 --- a/docs/developers/release-process.md +++ b/docs/developers/release-process.md @@ -31,6 +31,8 @@ After updating the version in the `Cargo.toml` files, we need to update the `Car - `crates/l2/prover/src/guest_program/src/risc0` - `crates/l2/tee/quote-gen` +Finally, stage and commit the changes to the release branch. + An example of a PR that bumps the version can be found [here](https://github.com/lambdaclass/ethrex/pull/4881/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542). ## 3rd - Create & Push Tag From a8863e7ea716261b7fc877d3403bd968e5a85f0c Mon Sep 17 00:00:00 2001 From: ilitteri Date: Tue, 11 Nov 2025 10:28:42 -0300 Subject: [PATCH 3/4] Use cargo tree instead of cargo update --- docs/developers/release-process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/release-process.md b/docs/developers/release-process.md index c80c389246c..d4844c3cbf2 100644 --- a/docs/developers/release-process.md +++ b/docs/developers/release-process.md @@ -24,7 +24,7 @@ Then, we need to update three more `Cargo.toml` files that are not part of the w - `crates/l2/prover/src/guest_program/src/risc0/Cargo.toml` - `crates/l2/tee/quote-gen/Cargo.toml` -After updating the version in the `Cargo.toml` files, we need to update the `Cargo.lock` files to reflect the new versions. Run `cargo update` in their respective directories: +After updating the version in the `Cargo.toml` files, we need to update the `Cargo.lock` files to reflect the new versions. Run `cargo tree` in their respective directories: - In the root directory - `crates/l2/prover/src/guest_program/src/sp1` From 9db984dc66ee8f5c2132ca333332bc2d0c06d10b Mon Sep 17 00:00:00 2001 From: ilitteri Date: Tue, 11 Nov 2025 11:37:25 -0300 Subject: [PATCH 4/4] Add final step --- docs/developers/release-process.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/developers/release-process.md b/docs/developers/release-process.md index d4844c3cbf2..651b4db0e73 100644 --- a/docs/developers/release-process.md +++ b/docs/developers/release-process.md @@ -31,6 +31,8 @@ After updating the version in the `Cargo.toml` files, we need to update the `Car - `crates/l2/prover/src/guest_program/src/risc0` - `crates/l2/tee/quote-gen` +Then, go to the `CLI.md` file located in `docs/` and update the version of the `--builder.extra-data` flag default value to match the new version (for both ethrex and ethrex l2 sections). + Finally, stage and commit the changes to the release branch. An example of a PR that bumps the version can be found [here](https://github.com/lambdaclass/ethrex/pull/4881/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542).