docs: correct the supported-version table and pin the hand-maintained bumps - #196
Conversation
… bumps SECURITY.md still said "The project has not yet cut a versioned release" and listed 0.1.0-SNAPSHOT as the only supported version, five releases after 1.0.0. It would have shipped that way with 1.2.0. The table now names the current release line, says older lines are not patched retroactively, and notes why upgrading within a line is only a version bump: the three artifacts are released together from one parent pom at a single version. That defect exists because `versions:set` rewrites only the poms and the runbook never said what else carries a version literal. Step 1 now lists them -- both READMEs, CLAUDE.md, SECURITY.md, the CHANGELOG heading and its two link refs -- with the grep that finds whatever was missed, to be run before the tag rather than after.
Review feedbackIssue 1: Outdated package reference in SECURITY.mdThe Scope section still references the old, renamed plugin package path: Per CLAUDE.md, the package was renamed to Issue 2: Unclear grep pattern in docs/RELEASE.mdThe grep command uses grep -rn "<previous version>" --include="*.md" .This won't find actual version occurrences. Users need clear guidance on what to substitute. Consider clarifying like: grep -rn "X.Y.Z" --include="*.md" . # where X.Y.Z is the old version being replacedOr provide a concrete example (e.g., when upgrading from 1.1.1 to 1.2.0). Otherwise, the documentation improvements are solid and address the real issue of stale version references. The SECURITY.md table is accurate and the RELEASE.md runbook additions provide valuable guidance for future releases. |
| - `SECURITY.md` — the supported-release-line table; | ||
| - `CHANGELOG.md` — the `## [X.Y.Z] - <date>` heading and the two link refs at the bottom. | ||
|
|
||
| `grep -rn "<previous version>" --include="*.md" .` finds what was missed; run it before tagging, |
There was a problem hiding this comment.
The grep pattern needs to be more specific. <previous version> as written won't match actual version literals. Users need guidance on what to substitute. Consider:
| `grep -rn "<previous version>" --include="*.md" .` finds what was missed; run it before tagging, | |
| `grep -rn "1.1.1" --include="*.md" .` (replace with the old version being bumped from) finds what was missed; run it before tagging, |
Or provide a clearer instruction explaining that users should substitute the old version number.
|



Summary
Two documentation defects a release-readiness audit surfaced. Both would have shipped with the 1.2.0 tag.
SECURITY.mdclaimed no release exists. It still said "The project has not yet cut a versioned release" and listed0.1.0-SNAPSHOTas the only supported version — five releases after 1.0.0, with 1.0.0 … 1.1.1 all resolvable on Central. A reporter reading it would conclude no released version is in scope. The table now names the current release line, states that older lines are not patched retroactively, and says why upgrading within a line costs nothing but a version bump: the three artifacts are released together from one parent pom at a single version.The runbook never said what
versions:setdoes not touch. That is why the above went stale.docs/RELEASE.mdstep 1 now enumerates every hand-maintained version literal — both READMEs,CLAUDE.md,SECURITY.md, theCHANGELOG.mdheading and its two link refs — with thegrepthat finds what was missed, to be run before the tag rather than after.Test plan
Documentation only; no code or build change.
net.ladenthin:srcmorph{,-cli,-maven-plugin}andsrcmorph-parentall return HTTP 200 at 1.1.1 on Central and 404 at 1.2.0, so "no versioned release" was factually wrong and 1.2.0 is free to publishgrep -rn "1\.1\.1" --include="*.md" .— the remaining hits are deliberate historical references (the retired relocation stub, thellamaLibraryPathremoval note, "last released version"), not stale snippetsRelated issues / PRs
Follows #194 and #195; prepares the
v1.2.0tag.Checklist
CONTRIBUTING.mdandCODE_OF_CONDUCT.mdGenerated by Claude Code