Skip to content

Commit a080b83

Browse files
committed
docs(libevm/tooling/release): add readme
1 parent 87a2d57 commit a080b83

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

libevm/tooling/release/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Release
2+
3+
In the following, we create a release candidate tag `v1.13.14-0.2.0.rc.4`.
4+
5+
1. Create two branches, usually from the `main` branch:
6+
7+
```bash
8+
git fetch origin main:main
9+
git checkout main
10+
git checkout -b release/v1.13.14-0.2.0.rc.4
11+
git push -u origin release/v1.13.14-0.2.0.rc.4
12+
git checkout -b myusername/release/v1.13.14-0.2.0.rc.4
13+
git push -u origin myusername/release/v1.13.14-0.2.0.rc.4
14+
```
15+
16+
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.
17+
1. Run script `./cherrypick.sh` which cherry picks all Geth commits listed in [cherrypicks](cherrypicks)
18+
- you may have to resolve conflicts
19+
1. Modify [params/version.libevm.go](/params/version.libevm.go)
20+
- Change the `LibEVMVersion` to the correct final version name
21+
- Change the `LibEVMReleaseType` to the correct release type, for example `ReleaseCandidate`
22+
- If planning a release candidate: set `libEVMReleaseCandidate` to the correct number; in this case `4`
23+
- If needed: change the `LibEVMVersionMajor`, `LibEVMVersionMinor` and `LibEVMVersionPatch` numbers
24+
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`.
25+
1. Push your modified branch to the remote `git push`
26+
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`"

0 commit comments

Comments
 (0)