Skip to content

docs: correct the supported-version table and pin the hand-maintained bumps #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bernardladenthin merged 1 commit into from
Sep 1, 2026
Merged

docs: correct the supported-version table and pin the hand-maintained bumps #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

## Supported versions

The project has not yet cut a versioned release. Security fixes are applied directly on `main` against the current development snapshot.
Security fixes land on `main` and ship in the next release from the current minor line. Older lines
are not patched retroactively: the three artifacts (`srcmorph`, `srcmorph-cli`,
`srcmorph-maven-plugin`) are released together from one parent pom at a single version, so upgrading
within a line is a version bump and nothing else.

| Version | Supported |
|---------|-----------|
| 0.1.0-SNAPSHOT (development, unreleased) | Security fixes applied on `main` |

> Note: once the first SemVer release is cut, this table will be updated to list the supported release line(s).
| 1.2.x (current release line) | ✅ Security fixes released from `main` |
| 1.1.x and older | ❌ Upgrade to the current line |
| `main` (development) | ✅ Fixes land here first |

---

Expand Down
12 changes: 12 additions & 0 deletions docs/RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ procedure:
(No `-Dexcludes` needed — the reactor's former 4th module, a relocation-stub POM for the
retired `net.ladenthin:llamacpp-ai-index-maven-plugin` coordinates, was removed after its one
`1.0.4` release; see `CLAUDE.md`.)

**`versions:set` rewrites only the poms.** These version literals are hand-maintained and must be
bumped in the same commit, or the published docs point consumers at the previous release:
- `README.md` — the `<dependency>`/`<plugin>` snippets **and** the "Current reactor version /
Last released version" line;
- `srcmorph-maven-plugin/README.md` — its own `<plugin>` snippet;
- `CLAUDE.md` — the reactor version and "Last released version" in the overview and layout blocks;
- `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,

@claude claude Bot Sep 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
`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.

not after.
2. **Commit, push, merge to `main`.**
3. **Tag the merge commit and push the tag:**
```bash
Expand Down
Loading