Bring the README version snippets up to 2.16.2-SNAPSHOT - #78
Merged
Merged
Conversation
The move to 2.16.2-SNAPSHOT updated the four poms, build.gradle and both gradle.properties, but left every README behind at 2.16.1-SNAPSHOT. That is five of the twelve declared locations, so anyone copying the dependency snippet out of a README got a version that is not what the project builds. CLAUDE.md calls this out as the recurring bug in this repo -- a bump touches some locations and not others, and nothing catches it until a build breaks months later. Gradle sat two versions behind Maven for five months the same way. Three of these are the replacer plugin's output, which only regenerates for modules that are actually built; cfml.cli/README.md and the versions:set example in the root README are the two the plugin never touches, so they were corrected by hand. Verified with the check CLAUDE.md prescribes: all twelve locations now report a single value. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GzpZFd4rnE1Yi2sVHAji35
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
2 participants
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.
The move to
2.16.2-SNAPSHOTupdated the four poms,build.gradleand bothgradle.properties, but left every README behind at2.16.1-SNAPSHOT— five of the twelve declared locations. Anyone copying the dependency snippet out of a README got a version the project does not build.README.mdsnippetREADME.mdversions:setexamplecfml.dictionary/README.mdcfml.parsing/README.mdcfml.cli/README.mdThis is the failure mode CLAUDE.md singles out as the recurring bug here — a bump touches some locations and not others, and nothing catches it until a build breaks months later. Gradle sat two versions behind Maven for five months the same way.
Why the replacer plugin did not already fix these
Three of the five are
replaceroutput, but it only regenerates READMEs for modules that are actually built — and the documented build is scoped (mvn -pl cfml.dictionary,cfml.parsing -am install), because building the whole reactor pulls incfml.cliand fails on a non-GraalVM JDK. Socfml.cli/README.mdis never regenerated in normal use.That one and the root README's
versions:setexample are the two the plugin never touches; both were corrected by hand.Verification
The check CLAUDE.md prescribes, across all twelve locations:
One distinct value throughout. Documentation only — no code, build or test changes.
Worth considering separately
cfml.cli/README.mdwill drift again on the next bump, for the same structural reason: the plugin that maintains it only runs in a build the project tells you not to run. Either the release process needs a step for it, or that README should not carry a version at all.🤖 Generated with Claude Code
https://claude.ai/code/session_01GzpZFd4rnE1Yi2sVHAji35
Generated by Claude Code