chore(l1): improve release docs#6960
Conversation
🤖 Kimi Code ReviewThe changes are documentation-only and generally look correct, but I have specific concerns regarding operational safety and maintainability:
|
Greptile SummaryThis PR improves two release-related documentation files with small but practical fixes found during real usage.
Confidence Score: 4/5Documentation-only changes; safe to merge with the minor placeholder inconsistency noted. Both files contain documentation improvements with no code logic changes. The upgrade-test.md fix is correct and straightforward. The release-process.md addition is useful real content, though the hardcoded version number in the wget URL and --version comment differs from the placeholder convention used elsewhere in the same document, which could cause a release engineer to accidentally use the wrong version on a future release. docs/developers/release-process.md — the new wget example uses a specific hardcoded version rather than the placeholder pattern the document prescribes.
|
| Filename | Overview |
|---|---|
| docs/developers/release-process.md | Replaces a TODO with real upgrade instructions for the Prysm/Lodestar/Teku/Grandine mainnet nodes; the bash snippet uses a hardcoded version (v20.0.0-rc.1) instead of the document's established vX.Y.Z-rc.W placeholder. |
| docs/developers/l2/upgrade-test.md | Adds missing \ line continuation after --proof-coordinator.addr 127.0.0.1 and appends the --no-monitor flag to the command block. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[SSH into mainnet node] --> B[tmux ls — list sessions]
B --> C[tmux a -t ethrex — attach]
C --> D[Ctrl-C — stop ethrex gracefully]
D --> E[exit tmux]
E --> F[wget new ethrex-linux-x86_64 binary]
F --> G[chmod +x binary]
G --> H[./ethrex-linux-x86_64 --version — verify]
H --> I[tmux new-session — restart ethrex]
I --> J[Verify node is syncing]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[SSH into mainnet node] --> B[tmux ls — list sessions]
B --> C[tmux a -t ethrex — attach]
C --> D[Ctrl-C — stop ethrex gracefully]
D --> E[exit tmux]
E --> F[wget new ethrex-linux-x86_64 binary]
F --> G[chmod +x binary]
G --> H[./ethrex-linux-x86_64 --version — verify]
H --> I[tmux new-session — restart ethrex]
I --> J[Verify node is syncing]
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
docs/developers/release-process.md:135-138
**Hardcoded version in example — should use the `vX.Y.Z-rc.W` placeholder**
The `wget` URL and the `--version` comment both use the literal `v20.0.0-rc.1` / `v20.0.0-` rather than the `vX.Y.Z-rc.W` placeholder that the rest of the document establishes at line 103. A release engineer following this section during a different release would have to remember to swap the URL manually, which is error-prone and inconsistent with the doc's own convention.
Reviews (1): Last reviewed commit: "improve release docs" | Re-trigger Greptile
🤖 Claude Code ReviewReview: PR 6960 —
|
| https://github.com/lambdaclass/ethrex/releases/download/v20.0.0-rc.1/ethrex-linux-x86_64 | ||
| chmod +x ethrex-linux-x86_64 | ||
|
|
||
| ./ethrex-linux-x86_64 --version # ethrex/v20.0.0- |
There was a problem hiding this comment.
Hardcoded version in example — should use the
vX.Y.Z-rc.W placeholder
The wget URL and the --version comment both use the literal v20.0.0-rc.1 / v20.0.0- rather than the vX.Y.Z-rc.W placeholder that the rest of the document establishes at line 103. A release engineer following this section during a different release would have to remember to swap the URL manually, which is error-prone and inconsistent with the doc's own convention.
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/developers/release-process.md
Line: 135-138
Comment:
**Hardcoded version in example — should use the `vX.Y.Z-rc.W` placeholder**
The `wget` URL and the `--version` comment both use the literal `v20.0.0-rc.1` / `v20.0.0-` rather than the `vX.Y.Z-rc.W` placeholder that the rest of the document establishes at line 103. A release engineer following this section during a different release would have to remember to swap the URL manually, which is error-prone and inconsistent with the doc's own convention.
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
🤖 Codex Code Review
No Rust/EVM/security findings beyond that; the Automated review by OpenAI Codex · gpt-5.4 · custom prompt |
| exit | ||
|
|
||
| wget -q -O ethrex-linux-x86_64 \ | ||
| https://github.com/lambdaclass/ethrex/releases/download/v20.0.0-rc.1/ethrex-linux-x86_64 |
There was a problem hiding this comment.
nit: v20.0.0-rc.1 is baked into the wget URL and the version-check comment on line 138 shows # ethrex/v20.0.0- (looks truncated). Would swapping in a <VERSION> placeholder — or a # replace with the target release tag note above the block — make this section stay copy-pasteable across future upgrades without editing the concrete tag each time? Not blocking.
Motivation
Improve the release related docs a bit on findings i found.
Description
Checklist
STORE_SCHEMA_VERSION(crates/storage/lib.rs) if the PR includes breaking changes to theStorerequiring a re-sync.