Repository navigation
ci: enforce the minor-version parity instead of documenting it - #25
Merged
Merged
Conversation
"0.19.x means implements spec 0.19" lived only in prose, which left it one typo from being silently false: a changelog heading naming 0.20.0 against a spec still at 0.19, or an implementation of 0.20 released as 0.19.4, and nothing anywhere would have failed. This repo now carries a SPEC_VERSION file naming the spec it implements, and check-version-parity.sh asserts two things in CI: the changelog's minor equals it, and every Utos.* package pin is on that same minor. A package on a different minor is on a different spec line, so a release claiming 0.19 while depending on 0.20 packages is refused. Checked at PR time rather than at release time, because at release time the mistake is a tag and a published artifact that cannot be taken back. Both halves verified by breaking them.
Windows git does not record the file mode, so chmod +x locally left it 100644 in the index and the CI step failed with 'Permission denied' before it could check anything. Set with git update-index --chmod=+x, which is mode-only and independent of the filesystem.
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
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.
"0.19.x means implements spec 0.19" lived only in prose — CLAUDE.md and the changelog headers. That left it one typo from being silently false.
Three ways it drifted, none of which failed a build
0.20.0, repo implements it, heading dated## [0.19.4]0.19, a bug fix dated## [0.20.0]0.20.xpackages, changelog left at0.19.xThe check
Each implementation carries a
SPEC_VERSIONfile naming the spec it implements, andscripts/check-version-parity.shruns first in CI:CHANGELOG.mdversion equals the minor ofSPEC_VERSIONUtos.*package pin is on that same minor — a package on a different minor is on a different spec lineChecked at PR time rather than release time, because at release time the mistake is a tag and a published artifact that cannot be taken back.
Verified by breaking it
Both halves, not just the happy path:
The message names which of the two is likely wrong, since "these disagree" is the easy half and "which one moved" is what a reader actually needs.
The script is runnable locally —
scripts/check-version-parity.sh— so a version change can be checked before pushing.