Skip to content

Commit a8217e1

Browse files
ilitterixqft
authored andcommitted
docs(l1,l2): improve release process docs second step (#5265)
**Motivation** The second step of the release process docs was missing some details. **Description** - Clarify which `Cargo.toml` file versions need to be bumped. - Specify to run `cargo update` in the corresponding workspaces. - Add `quote-gen` workspace to the list of workspaces to bump.
1 parent b92c785 commit a8217e1

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

docs/developers/release-process.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,28 @@ Examples:
1414

1515
## 2nd - Bump version
1616

17-
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.
17+
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.
1818

19-
An example can be found here:
19+
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.
2020

21-
https://github.com/lambdaclass/ethrex/pull/4881/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542
21+
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:
2222

23-
There are currently three `Cargo.lock` files that will be affected. Make sure you check them:
23+
- `crates/l2/prover/src/guest_program/src/sp1/Cargo.toml`
24+
- `crates/l2/prover/src/guest_program/src/risc0/Cargo.toml`
25+
- `crates/l2/tee/quote-gen/Cargo.toml`
2426

25-
- root `Cargo.lock`
26-
- `sp1/Cargo.lock`
27-
- `risc0/Cargo.lock`
27+
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:
28+
29+
- In the root directory
30+
- `crates/l2/prover/src/guest_program/src/sp1`
31+
- `crates/l2/prover/src/guest_program/src/risc0`
32+
- `crates/l2/tee/quote-gen`
33+
34+
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).
35+
36+
Finally, stage and commit the changes to the release branch.
37+
38+
An example of a PR that bumps the version can be found [here](https://github.com/lambdaclass/ethrex/pull/4881/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542).
2839

2940
## 3rd - Create & Push Tag
3041

0 commit comments

Comments
 (0)