Publish interim versions between releases - #42
Merged
Conversation
OpenSSF Best Practices repo_interim asks that reviewers have versions to look at between releases, not only final ones. The mechanism already existed -- bump.mk's prerelease labels -- but produced an unusable result: applying a label to a final version gave v1.23.0-dev.1, which semver orders before v1.23.0, so the interim version was older than the release it followed and no resolver would select it. Fixed upstream in the snippets rather than worked around here, so every repo vendoring bump.mk gets it. The core now advances first, by BUMP_PRERELEASE_STEP; the default of minor matches this project's cadence, so no override is needed. make bump dev v1.23.0 -> v1.24.0-dev.1 make bump dev -dev.1 -> -dev.2 make bump final -dev.2 -> v1.24.0 CONTRIBUTING documents the practice, which is what the criterion needs to point at.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses the
repo_interimcriterion in #39:What was actually wrong
The mechanism already existed —
bump.mkhas had prerelease labels all along —but it produced an unusable result. Applying a label to a final version gave:
Semver orders a prerelease before its own release, so that interim version
is older than the release it follows. No resolver would select it, and the
failure is silent: the tag is created and simply ignored.
Fixed upstream, not worked around here
The first attempt at this was a local
make interimwrapper. That was thewrong shape — it papered over a defect every repo vendoring the snippet
inherits. Fixed in
GNUMakefile-Snippets(PR #4)
and re-vendored here instead.
The core now advances before the label is applied, by
BUMP_PRERELEASE_STEP.Its default is
minor, which matches this project's cadence (1.20 → 1.21 →1.22 → 1.23), so no override is needed:
Counter advances and label switches are unaffected — they already target a core
ahead of the last release.
Scope
mk/bump.mkre-vendored — this file only.go-release.mk,version.mkand
changelog.mkhave also drifted behind upstream (they gainedTAG_PREFIX,v-parsing, andchangelog-depstargets). Those areindependent improvements and are deliberately left for their own PR.
CONTRIBUTING.mddocuments the practice, which is what the badge criterionneeds to point at — a target that merely exists proves nothing.
Also carries the
changelog.dsweep for the fragment v1.23.0 consumed.Verification
make checkclean.make bump dev DRYRUN=yesin this repo resolvesv1.23.0 -> v1.24.0-dev.1. The upstream PR carries the full behaviour matrix,including that
bump major/minor/patch/finalare unchanged.