Skip to content

Latest commit

 

History

History
96 lines (71 loc) · 4.58 KB

RELEASE.md

File metadata and controls

96 lines (71 loc) · 4.58 KB
Raw

Releasing a new version of mev-boost

This is a guide on how to release a new version of mev-boost:

  1. Best days to release a new version are Monday to Wednesday. Never release on a Friday.
  2. Release only with another person present (four eyes principle)
  3. Double-check the current build
  4. Prepare a release candidate (RC)
  5. Test the RC on testnets with the help of node operators
  6. Collect code signoffs
  7. Release

Double-check the current status

First of all, check that the git repository is in the final state, and all the tests and checks are running fine

Test the current

make lint
make test-race
go mod tidy
git status # should be no changes

# Start mev-boost with relay check and -relays
go run . -mainnet -relay-check -min-bid 0.12345 -debug -relays https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xb3ee7afcf27f1f1259ac1787876318c6584ee353097a50ed84f51a1f21a323b3736f271a895c7ce918c038e4265918be@relay.edennetwork.io,https://0x9000009807ed12c1f08bf4e81c6da3ba8e3fc3d953898ce0102433094e5f22f21102ec057841fcb81978ed1ea0fa8246@builder-relay-mainnet.blocknative.com -relay-monitors https://relay-monitor1.example.com,https://relay-monitor2.example.com

# Start mev-boost with relay check and multiple -relay flags
go run . -mainnet -relay-check -debug -min-bid 0.12345 \
    -relay https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net \
    -relay https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com \
    -relay https://0xb3ee7afcf27f1f1259ac1787876318c6584ee353097a50ed84f51a1f21a323b3736f271a895c7ce918c038e4265918be@relay.edennetwork.io \
    -relay https://0x9000009807ed12c1f08bf4e81c6da3ba8e3fc3d953898ce0102433094e5f22f21102ec057841fcb81978ed1ea0fa8246@builder-relay-mainnet.blocknative.com \
    -relay-monitor https://relay-monitor1.example.com \
    -relay-monitor https://relay-monitor2.example.com

# Call the status endpoint
curl localhost:18550/eth/v1/builder/status

Prepare a release candidate build and Docker image

For example, creating a new release v2.3.1-rc1:

# create a new branch
git checkout -b release/v2.3.1-rc1

# set and commit the correct version as described below, and create a signed tag
vim config/vars.go
git commit -am "v2.3.1-rc1"
git tag -s v2.3.1-rc1  # without a tag, the Docker image would include the wrong version number

# now push to Github (CI will build the Docker image: https://github.com/flashbots/mev-boost/actions)
git push origin --tags

# other parties can now test the release candidate from Docker like this:
docker pull flashbots/mev-boost:v2.3.1-rc1

Ask node operators to test this RC (on Goerli or Sepolia)

  • Reach out to node operators to help test this release
  • Collect their sign-off for the release

Collect code signoffs

  • Reach out to the parties that have reviewed the PRs and ask for a sign-off on the release
  • For possible reviewers, take a look at recent contributors

Release only with 4 eyes

  • Always have two people preparing and publishing the final release

Tagging a version and pushing the release

To create a new version (with tag), follow all these steps! They are necessary to have the correct build version inside, and work with go install.

  • Update Version in config/vars.go - change it to the next version (eg. from v2.3.1-dev to v2.3.1), and commit
  • Create a signed git tag: git tag -s v2.3.1
  • Update the stable branch:
    • git checkout stable
    • git merge tags/v2.3.1 --ff-only
    • git checkout main
    • git merge tags/v2.3.1 --ff-only
  • Update Version in config/vars.go to next patch with dev suffix (eg. v2.3.2-dev), commit to main and push to Github
  • Now push the main and stable branch, as well as the tag to Github: git push origin main stable --tags

Now check the Github CI actions for release activity: https://github.com/flashbots/mev-boost/actions