Skip to content

docs(l1,l2): improve release process docs second step #5265

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
merged 4 commits into from
Nov 11, 2025
Merged

docs(l1,l2): improve release process docs second step #5265

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2d00096
Improve release process docs second step
Nov 11, 2025
6d6a6b3
Add step for committing the changes to the release branch
Nov 11, 2025
a8863e7
Use cargo tree instead of cargo update
Nov 11, 2025
9db984d
Add final step
Nov 11, 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
25 changes: 18 additions & 7 deletions docs/developers/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,28 @@ 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 tree` in their respective directories:
Copy link
Collaborator

@MegaRedHand MegaRedHand Nov 11, 2025

Choose a reason for hiding this comment

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

Does cargo tree update the lockfile?

Copy link
Contributor Author

@ilitteri ilitteri Nov 11, 2025

Choose a reason for hiding this comment

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

Yes, it's even safer than cargo update because it doesn't update dependencies that you don't want to be updated.


- 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`

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).

## 3rd - Create & Push Tag

Expand Down