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.

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

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

qdm12
Copy link

@qdm12 qdm12 commented Mar 26, 2025

Why this should be merged

The documentation was lacking on how to create a new release tag, using newer automation tools developed.

How this works

Add readme.md in libevm/tooling/release and reference it in the root readme.md

How this was tested

Following each step to create https://github.com/ava-labs/libevm/releases/tag/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.

@qdm12 qdm12 requested a review from ARR4N March 28, 2025 07:52

```bash
VERSION=v1.13.14-0.2.0.rc.4
USERNAME=myusername
Copy link
Author

Choose a reason for hiding this comment

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

Change to GH_USER or it conflicts with OSX $USERNAME

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants