From f863bc302d94d4f8d0e68816cbe1693519d008b8 Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 4 Jul 2026 20:10:48 +0000 Subject: [PATCH] docs: fix stale module-README version + dedup README dependency snippets The 5.0.4 -> 5.0.5 release (PR #295) bumped the root README but missed llama-langchain4j/README.md, which still pointed consumers at 5.0.4. Root cause: the CLAUDE.md 'Version bump' section only said 'the README version examples and badge still need the usual manual update' without enumerating that there are TWO README files, so the module one was forgotten. Changes: - llama-langchain4j/README.md: 5.0.4 -> 5.0.5 (the stale snippet). - README.md: collapse the ~18 per-classifier snippets into one canonical default snippet + one template. The backend, target platform and runtime requirement already live once in the classifier table above, so the snippets were pure duplication. The release version now appears in ~4 spots instead of ~20. - CLAUDE.md: 'Version bump' section now enumerates BOTH README files that carry hardcoded release-version snippets (and notes the badge auto-pulls and the -SNAPSHOT line tracks the next dev version), so a future release cannot silently miss the module README again. No pom version is changed here; this branch is documentation + README consistency only, on top of the merged 5.0.5 release. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01RXWwtbpTWjesgJdBWS27GJ --- CLAUDE.md | 20 +++++- README.md | 130 +++--------------------------------- llama-langchain4j/README.md | 2 +- 3 files changed, 27 insertions(+), 125 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 1c861a53..543c6ad5 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1392,8 +1392,24 @@ versioning** here), so a version change must be applied to **all three poms in l The safe way is `mvn -q versions:set -DnewVersion=X.Y.Z -DgenerateBackupPoms=false` from the repo root (it updates the parent and every child `` reference at once). Changing only the root `` leaves the children pointing at a non-existent parent and **fails the reactor build** -(`Could not find artifact net.ladenthin:llama-parent:pom:X.Y.Z`). The README version examples and -badge still need the usual manual update. (If single-source ergonomics are wanted, the Maven +(`Could not find artifact net.ladenthin:llama-parent:pom:X.Y.Z`). + +`versions:set` only rewrites the **poms**. The **two README files** that carry hardcoded +release-version dependency snippets must be bumped **manually and in the same commit** — miss either +and the published docs point consumers at the previous release. (The `llama-langchain4j/README.md` +snippet was exactly the one forgotten on the `5.0.4 → 5.0.5` bump; it is listed here so it is not +missed again.) + +- **`README.md`** (root) — the install snippet, the two classifier-example snippets (default + the + `` template), and the `llama-langchain4j` snippet. The Maven Central **badge** + auto-pulls the latest released version, so leave it. The **`-SNAPSHOT` line** in the "Snapshot + builds" section documents the snapshot channel — set it to the *next* dev version, not the release. + (The per-classifier snippets were **deduplicated** to a single canonical + template pair, so the + release version now appears in only ~4 spots here, not ~20 — the runtime details live once in the + classifier table.) +- **`llama-langchain4j/README.md`** — its own `` snippet. + +(If single-source ergonomics are wanted, the Maven CI-friendly `${revision}` property + `flatten-maven-plugin` would let a bump touch only the root — that plugin is not configured today, so do not rely on "root only".) diff --git a/README.md b/README.md index 3dc4bd1b..6d9652c0 100644 --- a/README.md +++ b/README.md @@ -199,141 +199,27 @@ exclusive — and optionally a CPU Windows build. > inference is verified locally / on self-hosted hardware. As with every GPU JAR, > the vendor runtime is supplied by the consumer's driver/toolkit and is not bundled. +For the default CPU JAR, omit the ``. For a GPU/accelerator or +alternate-CPU build, add the `` for your platform from the table +above — the backend, target platform and runtime requirement are all listed +there. Pick **at most one** classifier (they are mutually exclusive): + ```xml - + net.ladenthin llama 5.0.5 - + net.ladenthin llama 5.0.5 cuda13-linux-x86-64 - - - - net.ladenthin - llama - 5.0.5 - opencl-android-aarch64 - - - - - net.ladenthin - llama - 5.0.5 - cuda13-windows-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - vulkan-windows-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - vulkan-linux-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - vulkan-linux-aarch64 - - - - - net.ladenthin - llama - 5.0.5 - opencl-windows-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - msvc-windows - - - - - net.ladenthin - llama - 5.0.5 - rocm-linux-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - rocm-windows-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - sycl-fp16-linux-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - sycl-fp32-linux-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - sycl-windows-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - opencl-windows-aarch64 - - - - - net.ladenthin - llama - 5.0.5 - openvino-linux-x86-64 - - - - - net.ladenthin - llama - 5.0.5 - openvino-windows-x86-64 - ``` > [!IMPORTANT] diff --git a/llama-langchain4j/README.md b/llama-langchain4j/README.md index 6b672aa8..e477f5cd 100644 --- a/llama-langchain4j/README.md +++ b/llama-langchain4j/README.md @@ -62,7 +62,7 @@ ScoringModel reranker = new JllamaScoringModel(rerankLlama); net.ladenthin llama-langchain4j - 5.0.4 + 5.0.5 ```