docs(l1,l2): improve release process docs second step #5265
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the release process documentation by expanding the "Bump version" step with more detailed and precise instructions.
- Clarifies that both
[workspace.package]version and three additional standaloneCargo.tomlfiles need to be updated - Adds explicit instructions to run
cargo updatein all affected workspaces - Includes the previously missing
quote-genworkspace in the list
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
edg-l
approved these changes
Nov 11, 2025
MegaRedHand
reviewed
Nov 11, 2025
| - 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: |
Collaborator
There was a problem hiding this comment.
Does cargo tree update the lockfile?
Contributor
Author
There was a problem hiding this comment.
Yes, it's even safer than cargo update because it doesn't update dependencies that you don't want to be updated.
MegaRedHand
approved these changes
Nov 11, 2025
Contributor
|
We should also add a step changing the version in the CLI reference docs ( |
xqft
pushed a commit
that referenced
this pull request
Nov 11, 2025
**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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The second step of the release process docs was missing some details.
Description
Cargo.tomlfile versions need to be bumped.cargo updatein the corresponding workspaces.quote-genworkspace to the list of workspaces to bump.