Skip to content

docs(libevm/tooling/release): add readme #170

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

Closed
wants to merge 16 commits into from
Closed

docs(libevm/tooling/release): add readme #170

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a080b83
docs(libevm/tooling/release): add readme
qdm12 Mar 26, 2025
92023af
Refer tooling/release in main readme
qdm12 Mar 26, 2025
c4b262f
Add more steps
qdm12 Mar 26, 2025
c42928b
Fix tag push git command
qdm12 Mar 26, 2025
b0ca643
Add details to step 1.
qdm12 Mar 28, 2025
2a0aa1d
Simplify step 2 to be a single line
qdm12 Mar 28, 2025
3b326a3
Change tag to version in introduction
qdm12 Mar 28, 2025
8f400ec
Simplify README.md reference to release creation document
qdm12 Mar 28, 2025
ab8fbb1
Precise unit test checks the version string is correct
qdm12 Mar 28, 2025
8285be7
Move remote push of branch from step 1 to step 5
qdm12 Mar 28, 2025
de4b8b2
typo fix
qdm12 Mar 28, 2025
f28b610
Move LibEVMVersion setting as last bullet point
qdm12 Mar 28, 2025
2b57993
Add you should amend commits responsible for CI errors
qdm12 Mar 28, 2025
06b95ab
Use variables USERNAME and VERSION
qdm12 Mar 28, 2025
6cbf989
Add reference to LibEVMVersion godoc comment
qdm12 Apr 12, 2025
b68391c
Rename USERNAME to GH_USER variable
qdm12 May 22, 2025
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ with `geth`.

We are immensely grateful for the hard work of the `geth` authors, and hope that our contribution can be of value to others too. Thank you!

If you want to create a release, please refer to [libevm/tooling/release](libevm/tooling/release)

## Go Ethereum

Golang execution layer implementation of the Ethereum protocol.
Expand Down
26 changes: 26 additions & 0 deletions libevm/tooling/release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Release

In the following, we create a release candidate tag `v1.13.14-0.2.0.rc.4`.

1. Create two branches, usually from the `main` branch:

```bash
git fetch origin main:main
git checkout main
git checkout -b release/v1.13.14-0.2.0.rc.4
git push -u origin release/v1.13.14-0.2.0.rc.4
git checkout -b myusername/release/v1.13.14-0.2.0.rc.4
git push -u origin myusername/release/v1.13.14-0.2.0.rc.4
```

The `myusername/release/v1.13.14-0.2.0.rc.4` branch will be used to add "release modifications" and will target the branch `release/v1.13.14-0.2.0.rc.4` in a pull request.
1. Run script `./cherrypick.sh` which cherry picks all Geth commits listed in [cherrypicks](cherrypicks)
- you may have to resolve conflicts
1. Modify [params/version.libevm.go](/params/version.libevm.go)
Copy link
Collaborator

Choose a reason for hiding this comment

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

It's useful to have this as the first step but NOT have anything committed. That way the version string is automatically generated for naming the release branch.

Copy link
Author

Choose a reason for hiding this comment

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

That way the version string is automatically generated for naming the release branch.

Through a test right?
I think it's best to keep it as it is, and have the CI check on the version string humanly typed, to avoid any bad copy-paste surprises.

- Change the `LibEVMVersion` to the correct final version name
- Change the `LibEVMReleaseType` to the correct release type, for example `ReleaseCandidate`
- If planning a release candidate: set `libEVMReleaseCandidate` to the correct number; in this case `4`
- If needed: change the `LibEVMVersionMajor`, `LibEVMVersionMinor` and `LibEVMVersionPatch` numbers
1. Commit your modifications to [params/version.libevm.go](/params/version.libevm.go) with a commit title `chore: release v1.13.14-0.2.0.rc.4`.
1. Push your modified branch to the remote `git push`
1. Open a pull request from your modified branch `myusername/release/v1.13.14-0.2.0.rc.4` and targeting `release/v1.13.14-0.2.0.rc.4`, for example with `https://github.com/ava-labs/libevm/compare/release/v1.13.14-0.2.0.rc.4...myusername/release/v1.13.14-0.2.0.rc.4?expand=1`. Set the tile to "chore: release `v1.13.14-0.2.0.rc.4`"
Loading