cleanup (#863)

Author: metachris

.github/workflows/release.yaml

@@ -60,6 +60,7 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
 
   build-all:
+    name: Build Binaries
     runs-on: warp-ubuntu-latest-x64-16x
     steps:
       - name: Checkout
@@ -89,6 +90,7 @@ jobs:
             dist/mev-boost*.txt
 
   release:
+    name: Prepare Github Release
     needs: build-all
     runs-on: warp-ubuntu-latest-x64-16x
     steps:
@@ -120,4 +122,4 @@ jobs:
         with:
           args: release --config .goreleaser-release.yaml
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,10 +1,11 @@
 ![mev-boost](https://user-images.githubusercontent.com/116939/224986867-3d1916c6-3219-4d61-b1ce-213fc663070c.png)
 
-#
+---
 
 [![Goreport status](https://goreportcard.com/badge/github.com/flashbots/mev-boost)](https://goreportcard.com/report/github.com/flashbots/mev-boost)
-[![Test status](https://github.com/flashbots/mev-boost/workflows/Tests/badge.svg?branch=develop)](https://github.com/flashbots/mev-boost/actions?query=workflow%3A%22Tests%22)
-[![Docker hub](https://badgen.net/docker/size/flashbots/mev-boost?icon=docker&label=image)](https://hub.docker.com/r/flashbots/mev-boost/tags)
+[![Test status](https://github.com/flashbots/mev-boost/actions/workflows/tests.yml/badge.svg?branch=develop)](https://github.com/flashbots/mev-boost/actions?query=workflow%3A%22Tests%22)
+[![Docker hub](https://img.shields.io/docker/image-size/flashbots/mev-boost
+)](https://hub.docker.com/r/flashbots/mev-boost/tags)
 
 ## What is MEV-Boost?
 
@@ -40,19 +41,26 @@ See also:
 
 # Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [Background](#background)
 - [Installing](#installing)
   - [Binaries](#binaries)
   - [From source](#from-source)
+    - [`go install`](#go-install)
+    - [Clone and Build](#clone-and-build)
   - [From Docker image](#from-docker-image)
   - [Systemd configuration](#systemd-configuration)
 - [Usage](#usage)
+  - [Note on usage documentation](#note-on-usage-documentation)
   - [Mainnet](#mainnet)
   - [Sepolia testnet](#sepolia-testnet)
   - [Holesky testnet](#holesky-testnet)
   - [Hoodi testnet](#hoodi-testnet)
   - [`test-cli`](#test-cli)
   - [mev-boost cli arguments](#mev-boost-cli-arguments)
+    - [`-relays` vs `-relay`](#-relays-vs--relay)
+    - [Setting a minimum bid value with `-min-bid`](#setting-a-minimum-bid-value-with--min-bid)
+    - [Enabling metrics](#enabling-metrics)
 - [API](#api)
 - [Maintainers](#maintainers)
 - [Contributing](#contributing)

RELEASE.md

@@ -1,16 +1,17 @@
 # Releasing a new version of mev-boost
 
-This is a guide on how to release 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.
-1. Release only with another person present (four eyes principle)
+The best days to release a new version are Monday to Wednesday. Never release on a Friday. Release preferred with another person present (four eyes principle).
+
+Process:
 1. Double-check the current build
-1. Prepare a release candidate (RC)
-1. Test the RC on testnets with the help of node operators
-1. Collect code signoffs
-1. Release
+2. Create a release candidate (RC)
+3. Test the RC on testnets
+4. Collect signoffs
+5. Create the full release + announcement
 
-## Double-check the current status
+## Double-check the current build
 
 First of all, check that the git repository is in the final state, and all the tests and checks are running fine
 
@@ -23,83 +24,48 @@ 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://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money
+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://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money
 
 # 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://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money
 
 # Call the status endpoint
 curl localhost:18550/eth/v1/builder/status
 ```
 
-## Prepare a release candidate build and Docker image
+## Make a release
 
-For example, creating a new release `v1.9`:
+Let's release `v1.9`:
 
 1. Create a GitHub issue about the upcoming release ([example](https://github.com/flashbots/mev-boost/issues/524))
-2. Create a release branch: `release/v1.9` (note: use the target version as branch name, don't add the `-alpha` suffix)
-3. Tag an alpha version: `v1.9-alpha1`
-4. Test in testnets, iterate as needed, create more alpha versions if needed
-5. When tests are complete, create the final tag and release
-6.
+1. Tag a release candidate (RC), or alpha version: `v1.9-rc1`, and push the new tag to GitHub.
+    - The [release CI](https://github.com/flashbots/mev-boost/actions) starts
+building the binaries and the Docker image (which is then pushed to [Docker Hub](https://hub.docker.com/r/flashbots/mev-boost/tags)).
+    - Binaries can be downloaded from the release CI summary website.
+1. Test the RC in testnets. Iterate as needed, create more alpha versions / release candidates as needed.
+2. When tests are complete, create the release: tag, GitHub release, `stable` branch update.
 
 ```bash
-# create a new branch
-git checkout -b release/v1.9
-
-# set and commit the correct version as described below, and create a signed tag
-vim config/vars.go
-git commit -am "v1.9-alpha1"
-git tag -s v1.9-alpha1  # without a tag, the Docker image would include the wrong version number
+# Create the RC tag
+git tag -s v1.9-rc1
 
-# now push to Github (CI will build the Docker image: https://github.com/flashbots/mev-boost/actions)
-git push origin --tags
+# Push to Github, which kicks off the release CI
+git push origin tags/v1.9-rc1
 
-# other parties can now test the release candidate from Docker like this:
+# When CI is done, the Docker image can be used
 docker pull flashbots/mev-boost:v1.9a1
-```
-
-## Ask node operators to test this RC (on Sepolia or Holesky)
-
-* 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](https://github.com/flashbots/mev-boost/graphs/contributors)
+# Once testing is done, tag the full release
+git tag -s v1.9
+git tag -s v1.9.0
 
-## Release only with 4 eyes
+# Push to Github, which kicks off the release CI
+git push origin tags/v1.9 tags/v1.9.0
 
-* 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`.
-
-* In the release branch
-* Update [`Version`](/config/vars.go) to final version to `v1.9`, and commit
-* Create final tags, both semver and pep440:
-  * `git tag -s v1.9`
-  * `git tag -s v1.9.0`
-* Update the `stable` branch:
-  * `git checkout stable`
-  * `git merge tags/v1.9 --ff-only` (ff-only is important, otherwise git doesn't know the stable branch is based off the v1.9 tag!)
-* Update the `develop` branch:
-  * `git checkout develop`
-  * `git merge tags/v1.9 --ff-only`
-* Update `Version` in `config/vars.go` to next patch with `dev` suffix (e.g. `v1.10-dev`) and commit to `develop` branch
-* Now push the `develop` and `stable` branches, as well as the tag: `git push origin develop stable --tags`
-
-Now check the GitHub CI actions for release activity: https://github.com/flashbots/mev-boost/actions
-* CI builds and pushes the Docker image, and prepares a new draft release in https://github.com/flashbots/mev-boost/releases
-* Open it and prepare the release:
-  * generate the description
-  * review
-  * add signoffs and testing
-  * add usage (`mev-boost -help`)
-  * publish
+# Finally, update the stable branch
+git checkout stable
+git merge tags/v1.9 --ff-only
+```