Skip to content

docs: bump Go to 1.24+, fix develop branch note, refresh CLI help - #913

Open
imitater-dou wants to merge 1 commit into
flashbots:developfrom
imitater-dou:docs/readme-go124-develop-cli-help
Open

imitater-dou wants to merge 1 commit into
flashbots:developfrom
imitater-dou:docs/readme-go124-develop-cli-help

Conversation

@imitater-dou

Copy link
Copy Markdown

Summary

Tip-verified README drift against develop @ 203bb9659eea613caefd198c67df4c6a8e6bf5d6:

  1. Go version — README said Go 1.18+; go.mod declares go 1.24.0 and CI uses ^1.24.
  2. Branch name — README claimed docs track main, but that branch does not exist (default is develop; releases use stable).
  3. CLI help dump — hand-maintained -help text still listed separate -relay / -relays flags and omitted genesis-timestamp and request-max-retries. Regenerated from ./mev-boost -help built at tip; clarified that --relay / --relays are aliases.
  4. Ethstaker relay list — remyroy/ethstaker path soft-redirects to an archived guides repo; point the primary link at the live https://ethstaker.cc/mev-relay-list/ page.

Repro

# Go claim
curl -sL https://raw.githubusercontent.com/flashbots/mev-boost/develop/go.mod | head -3
# → go 1.24.0

# main branch missing
gh api repos/flashbots/mev-boost/branches/main
# → 404

# CLI help at tip
git clone --depth 1 --branch develop https://github.com/flashbots/mev-boost.git
cd mev-boost && CGO_ENABLED=0 go build -o mev-boost ./cmd/mev-boost
./mev-boost -help | grep -E 'genesis-timestamp|request-max-retries|relays'

Test plan

  • Diff is README-only
  • Help dump matches local ./mev-boost -help at tip
  • Ethstaker primary URL returns HTTP 200

Signed-off-by: ADou <ikun3.1415927@gmail.com>
Copilot AI lite review requested due to automatic review settings September 24, 2026 02:18

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Correct the README TOC anchor for the relay heading.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Low severity

Open (1)
What changed in this PR

Updates README documentation for Go 1.24+, branch naming, CLI help, and relay resources.

Changes:

  • Updates Go, branch, and Ethstaker relay-list references.
  • Refreshes CLI help and clarifies relay flag aliases.
  • Fixes documentation alignment with current project behavior.

The README TOC contains a link to a nonexistent relay heading anchor and requires correction.

File Summary
README.md Updates project and CLI documentation.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md
- [`test-cli`](#test-cli)
- [mev-boost cli arguments](#mev-boost-cli-arguments)
- [`-relays` vs `-relay`](#-relays-vs--relay)
- [`--relay` / `--relays`](#-relay--relays)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants