diff --git a/docs/ai/reth-update-review.md b/docs/ai/reth-update-review.md index 4b303858336..b1648d264ae 100644 --- a/docs/ai/reth-update-review.md +++ b/docs/ai/reth-update-review.md @@ -280,6 +280,11 @@ a **minor** bump, `op-revm` at `20.x` only by a major. So: **if the adaptation diff changes a `version =` line in one of our published crates, say so in the review.** It is a release-coordination item, not just a manifest edit. +The op-reth crates (`op-reth`, `reth-optimism-*`, `reth-op`) and the `op-alloy*` crates +are each versioned as a group (UPDATING-RETH step 4): flag a `version =` change that moves +only part of a family, and check whether sibling crates changed their public API without a +bump. + ## Review process 1. Identify the old→new pins from the `Cargo.toml` diff; compute the lockfile diff --git a/rust/UPDATING-RETH.md b/rust/UPDATING-RETH.md index c3192beef9f..2c9dc8103a4 100644 --- a/rust/UPDATING-RETH.md +++ b/rust/UPDATING-RETH.md @@ -140,6 +140,14 @@ main's CI actually validated. one, call it out in the PR description so the downstream pin can move with it. + When a bump is genuinely needed, **version in-tree crate families as a + group.** Upstream reth versions every crate from one workspace version; two + in-tree families follow the same rule: the published op-reth crates + (`op-reth`, `reth-optimism-*`, `reth-op`) and the `op-alloy*` crates. When + any crate of a family needs a new version, bump the whole family to the + same version. A lone bump leaves siblings whose API also changed at a + version that downstream requirements still accept. + 5. Refresh both lockfiles — the main workspace and the SP1 guest programs workspace each have their own. `cargo update -p reth` does **not** work — there is no top-level crate literally named `reth` in the dependency graph.