mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-20 13:44:31 +00:00
25e5ca3eb1
## Why this should be merged I messed up the format of `rc` version tags, resulting in `rc.1` being considered a later version that `rc.2`. ## How this works The [release tagging](https://github.com/ava-labs/libevm/discussions/37) pattern that includes a combination of `geth` and `libevm` semver triplets (e.g. `1.13.14-0.1.0`) doesn't work well with extra identifiers like `rc` because more pre-release identifiers (those after `-`) take higher precedence if all those before them match. We therefore have to use a `release` suffix (`"release" > "rc"` in ASCII). This all became too much to expect to be done manually so I chucked it in code instead. ## How this was tested Unit test demonstrates expectation of version ordering.
93 lines
3.1 KiB
Go
93 lines
3.1 KiB
Go
// Copyright 2024 the libevm authors.
|
|
//
|
|
// The libevm additions to go-ethereum are free software: you can redistribute
|
|
// them and/or modify them under the terms of the GNU Lesser General Public License
|
|
// as published by the Free Software Foundation, either version 3 of the License,
|
|
// or (at your option) any later version.
|
|
//
|
|
// The libevm additions are distributed in the hope that they will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
|
|
// General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see
|
|
// <http://www.gnu.org/licenses/>.
|
|
|
|
package params
|
|
|
|
import "fmt"
|
|
|
|
const (
|
|
LibEVMVersionMajor = 0
|
|
LibEVMVersionMinor = 1
|
|
LibEVMVersionPatch = 0
|
|
|
|
libEVMReleaseType releaseType = betaRelease
|
|
libEVMReleaseCandidate uint = 0 // ignored unless [libEVMReleaseType] == [releaseCandidate]
|
|
)
|
|
|
|
// LibEVMVersion holds the textual version string of `libevm` modifications.
|
|
//
|
|
// Although compliant with [semver v2], it follows additional rules:
|
|
//
|
|
// 1. Major, minor, and patch MUST be the respective `geth` values;
|
|
// 2. The first three pre-release identifiers MUST be a semver-compliant
|
|
// triplet denoting the `libevm` "version";
|
|
// 3. On the `main` (development) branch, the final identifier MUST be "alpha"
|
|
// or "beta";
|
|
// 3. If a production version, the final identifier MUST be "release"; and
|
|
// 4. If a release candidate, the final two identifiers MUST be "rc" and an
|
|
// incrementing numeric value.
|
|
//
|
|
// The benefits of this pattern are that (a) it captures all relevant
|
|
// information; and (b) it follows an intuitive ordering under semver rules.
|
|
// Precedence is determined first by the `geth` version then the `libevm`
|
|
// version, with release candidates being lower than actual releases.
|
|
//
|
|
// The primary drawbacks is that it requires an explicit "release" identifier
|
|
// because of the use of pre-release identifiers to capture the `libevm`
|
|
// triplet.
|
|
//
|
|
// [semver v2]: https://semver.org/
|
|
var LibEVMVersion = func() string {
|
|
v := libEVMSemver{
|
|
geth: semverTriplet{VersionMajor, VersionMinor, VersionPatch},
|
|
libEVM: semverTriplet{LibEVMVersionMajor, LibEVMVersionMinor, LibEVMVersionPatch},
|
|
typ: libEVMReleaseType,
|
|
rc: libEVMReleaseCandidate,
|
|
}
|
|
return v.String()
|
|
}()
|
|
|
|
type semverTriplet struct {
|
|
major, minor, patch uint
|
|
}
|
|
|
|
func (t semverTriplet) String() string {
|
|
return fmt.Sprintf("%d.%d.%d", t.major, t.minor, t.patch)
|
|
}
|
|
|
|
type releaseType string
|
|
|
|
const (
|
|
// betaRelease MUST be used on `main` branch
|
|
betaRelease = releaseType("beta")
|
|
// Reserved for `release/*` branches
|
|
releaseCandidate = releaseType("rc")
|
|
productionRelease = releaseType("release")
|
|
)
|
|
|
|
type libEVMSemver struct {
|
|
geth, libEVM semverTriplet
|
|
typ releaseType
|
|
rc uint
|
|
}
|
|
|
|
func (v libEVMSemver) String() string {
|
|
suffix := v.typ
|
|
if suffix == releaseCandidate {
|
|
suffix = releaseType(fmt.Sprintf("%s.%d", suffix, v.rc))
|
|
}
|
|
return fmt.Sprintf("%s-%s.%s", v.geth, v.libEVM, suffix)
|
|
}
|