Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme + release cleanup #468

Merged
merged 3 commits into from
Mar 15, 2023
Merged

readme + release cleanup #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61894fa
readme + release cleanup
metachris Mar 14, 2023
0021242
Update README.md
metachris Mar 15, 2023
ba7a7d5
Update RELEASE.md
metachris Mar 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![mev-boost](https://user-images.githubusercontent.com/116939/179831878-dc6a0f76-94f4-46cc-bafd-18a3a4b58ea4.png)
![mev-boost](https://user-images.githubusercontent.com/116939/224986867-3d1916c6-3219-4d61-b1ce-213fc663070c.png)

#

Expand Down Expand Up @@ -94,7 +94,7 @@ Requires [Go 1.18+](https://go.dev/doc/install).

### `go install`

Install MEV-Boost with `go install`:
Install the latest MEV-Boost release with `go install`:

```bash
go install github.com/flashbots/mev-boost@latest
Expand Down Expand Up @@ -366,9 +366,12 @@ sequenceDiagram
# Maintainers

- [@metachris](/~https://github.com/metachris)
- [@jtraglia](/~https://github.com/jtraglia)
- [@ralexstokes](/~https://github.com/ralexstokes)
- [@terencechain](/~https://github.com/terencechain)
- [@lightclient](/~https://github.com/lightclient)
- [@avalonche](/~https://github.com/avalonche)
- [@Ruteri](/~https://github.com/Ruteri)
- [@elopio](/~https://github.com/elopio)
- [@kailinr](/~https://github.com/kailinr)

# Contributing

Expand Down Expand Up @@ -402,7 +405,3 @@ ecosystem more secure.
The code in this project is free software under the [MIT License](LICENSE).

Logo by [@lekevicius](https://twitter.com/lekevicius) on CC0 license.

---

Made with ☀️ by the 💎 researchers and developers.
7 changes: 5 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,13 @@ git tag -s v2.3.1-rc1 # without a tag, the Docker image would include the wrong
# now push to Github (CI will build the Docker image: /~https://github.com/flashbots/mev-boost/actions)
git push origin --tags

# you can also manually create and push the Docker image
# all done here
Copy link
Collaborator

Choose a reason for hiding this comment

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

"all done here" ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yep, all is done here :)

#
# if you want to manually create and push the Docker image:
make docker-image-portable
make docker-push-version

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

Expand Down Expand Up @@ -86,6 +88,7 @@ To create a new version (with tag), follow all these steps! They are necessary t
* `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`

Expand Down