docs(l1,l2): add pre-release checklist section #5537
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive pre-release documentation for the ethrex project, reorganizing the release process documentation into a dedicated section with a detailed checklist for testing binaries and Docker images before final release.
- Adds a new pre-release checklist document with testing tables for binaries and Docker images across multiple architectures
- Reorganizes release documentation into a structured directory (
docs/developers/release-process/) - Updates navigation structure in SUMMARY.md to reflect the new organization
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/developers/release-process/release-process.md | New comprehensive release process documentation covering branch creation, version bumping, tagging, testing, and publishing |
| docs/developers/release-process/pre-release-checklist.md | New pre-release testing checklist with tables for tracking binary and Docker image validation across architectures |
| docs/developers/release-process/README.md | New overview document linking to release process and checklist documents |
| docs/SUMMARY.md | Updated navigation structure to organize release documentation under a new subdirectory with nested sections |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Binary | Snapsync Hoodi | ethrex --dev | L2 Integration Tests | | ||
| |-------------------------------|----------------|--------------|----------------------| | ||
| | ethrex-macos-aarch64 | | | N/A (L2-bin-specific) | | ||
| | ethrex-linux-aarch64 | | | N/A (L2-bin-specific) | | ||
| | ethrex-linux-x86_64 | | | N/A (L2-bin-specific) | | ||
| | ethrex-l2-macos-aarch64 | | | | | ||
| | ethrex-l2-linux-aarch64 | | | | | ||
| | ethrex-l2-linux-x86_64 | | | | | ||
| | ethrex-l2-linux-aarch64-gpu | | | | | ||
| | ethrex-l2-linux-x86_64-gpu | | | | |
There was a problem hiding this comment.
Inconsistent binary naming format in the table. The binaries use underscore notation (e.g., ethrex-linux-x86_64) but there's an inconsistency: line 23 shows ethrex-linux-x86_64 while the pattern in the release-process.md shows ethrex-linux-x86-64 (with hyphen instead of underscore). Please verify and use consistent naming throughout (either x86_64 or x86-64).
MegaRedHand
left a comment
MegaRedHand
left a comment
There was a problem hiding this comment.
LGTM. Left some comments for further improvements
| ### Running the Tests | ||
|
|
||
| - **Snapsync Hoodi**: Follow the [snap sync guide for Hoodi](https://docs.ethrex.xyz/l1/running/index.html) to initialize and sync a test network. | ||
| - **ethrex --dev**: Launch Ethrex in development mode (`./ethrex --dev`) and verify it starts without errors, processes basic transactions, and handles RPC calls. |
There was a problem hiding this comment.
The "smoke test" part sounds good. We should add more documentation for the "processes basic transactions, and handles RPC calls". It might be worth it to use an integration test suite, like hive or tooling/reorgs, in this step.
|
|
||
| ### Running the Tests | ||
|
|
||
| - **Snapsync Hoodi**: Follow the [snap sync guide for Hoodi](https://docs.ethrex.xyz/l1/running/index.html) to initialize and sync a test network. |
There was a problem hiding this comment.
I think we can automate the syncing in the CI, which simplifies doing it for other architectures
| ### Running the Tests | ||
|
|
||
| - **Snapsync Hoodi**: Follow the [snap sync guide for Hoodi](https://docs.ethrex.xyz/l1/running/index.html) to initialize and sync a test network. | ||
| - **L2 Integration Tests**: Follow the [L2 integration tests guide](https://docs.ethrex.xyz/developers/l2/integration-tests.html). |
There was a problem hiding this comment.
Should we also add --dev and l2 --dev test?
No description provided.