Skip to content

docs(readmes): fix stale version refs in SB4 demo + ssrf-guard KO READMEs#55

Merged
jlc488 merged 1 commit into
mainfrom
fix/stale-version-refs-in-readmes
May 23, 2026
Merged

docs(readmes): fix stale version refs in SB4 demo + ssrf-guard KO READMEs#55
jlc488 merged 1 commit into
mainfrom
fix/stale-version-refs-in-readmes

Conversation

@jlc488
Copy link
Copy Markdown
Contributor

@jlc488 jlc488 commented May 23, 2026

Summary

Five spots where the README prose lagged behind the actual build.gradle.kts pin:

Demo File Line Was Now
easy-paging-sb4-demo README.md 76 :0.4.0 :0.5.0
easy-paging-sb4-demo README.ko.md 76 :0.4.0 :0.5.0
easy-paging-sb4-keyset-demo README.md 92 :0.4.0 :0.5.0
easy-paging-sb4-keyset-demo README.ko.md 92 :0.4.0 :0.5.0
ssrf-guard-demo README.ko.md 127 resttemplate:3.0.1, webclient:3.0.1 :3.1.0, :3.1.0

Root cause

SB4 demos (4 files): When PR #39 forked the SB4 demos from the SB3 originals, the build files and the > ✨ Spring Boot 4 line. ... 0.5.x line header callout were correctly retargeted to 0.5.0, but the "Files of interest" detail table at the bottom of each README still said 0.4.0. The English READMEs for the postgres/reactive demos don't repeat the version in prose, so only the 4 files above were affected.

ssrf-guard (1 file): PR #52 (ssrf-guard 3.0.1 → 3.1.0 + langchain4j demo) bumped the README header and the meta-artifact mention, and updated all three sub-artifact lines in the English README (line 128). The Korean equivalent on line 127 only got the first artifact bumped — the half-update slipped through review.

Not changed (intentional)

All :0.4.0 references in the SB3 demo READMEs (easy-paging-demo, easy-paging-keyset-demo, easy-paging-postgres-demo, easy-paging-reactive-demo) are correct — those demos pin to the 0.4.x maintenance line on purpose, per the dual-line policy.

Test plan

  • CI green
  • After merge, grep -rn "easy-paging-spring-boot-starter:0.4.0" easy-paging-sb4-*/README* returns nothing
  • After merge, grep -rn "ssrf-guard[a-z-]*:3.0" ssrf-guard-*/README* returns nothing

…DMEs

Five spots where the README prose lagged behind the actual build.gradle.kts
pin. The build files were correct; the README narrative just got copy-pasted
from the SB3 source demo (or, for ssrf-guard, only half-bumped during the
3.0.1 -> 3.1.0 sweep) and never re-grepped.

SB4 demos (4 files) — "Files of interest" table said the dep is
:easy-paging-spring-boot-starter:0.4.0 but build.gradle.kts pins :0.5.0:

  easy-paging-sb4-demo/README.md           line 76: 0.4.0 -> 0.5.0
  easy-paging-sb4-demo/README.ko.md        line 76: 0.4.0 -> 0.5.0
  easy-paging-sb4-keyset-demo/README.md    line 92: 0.4.0 -> 0.5.0
  easy-paging-sb4-keyset-demo/README.ko.md line 92: 0.4.0 -> 0.5.0

  Root cause: when the four SB4 demos were branched off the SB3 demos in
  PR #39, build.gradle.kts and the README header callout ("Spring Boot 4
  line. ... 0.5.x line") were correctly retargeted to 0.5.0, but the
  detail table at the bottom of the README ("the only dependency the demo
  adds...") was left at 0.4.0. The English ones for postgres/reactive
  don't repeat the version in prose so they were unaffected.

ssrf-guard demo (1 file) — only the Korean README, "Files of interest" row
listed three sub-artifacts but mixed two versions:

  ssrf-guard-demo/README.ko.md line 127:
    :ssrf-guard:3.1.0, :ssrf-guard-resttemplate:3.0.1, :ssrf-guard-webclient:3.0.1
      -> :ssrf-guard:3.1.0, :ssrf-guard-resttemplate:3.1.0, :ssrf-guard-webclient:3.1.0

  Root cause: PR #52 ("ssrf-guard 3.0.1 -> 3.1.0 + langchain4j demo")
  bumped the README header and the meta-artifact mention but only the
  first of the three sub-artifact lines on line 127 of the KO file; the
  English README on line 128 got all three. KO half-update slipped through
  review.

All SB3 demo READMEs that still reference :0.4.0 are intentional - the SB3
demos pin to the 0.4.x maintenance line on purpose. Verified by grep that
no other build.gradle.kts vs README mismatches remain.
@jlc488 jlc488 merged commit 83f00ea into main May 23, 2026
5 checks passed
jlc488 added a commit that referenced this pull request May 23, 2026
…nded (#59)

Deferred from the earlier badge PR (#56, closed) — that one used the
pre-renumber prefixes (versionPrefix=0.4 / 0.5). After #57 landed
the renumber (easy-paging 0.4.0→3.0.0, 0.5.0→4.0.0), this PR finishes
the badge conversion with the correct post-renumber prefixes.

Changes per language (2 files, 40 lines each):

  Section headers — align with the renumber:
    "Spring Boot 4 (`0.5.x` line)"       → "(`4.x` line)"
    "Spring Boot 3 maintenance (`0.4.x` line)" → "(`3.x` line)"
    Korean equivalents.

  Maintenance branch link — the branch was renamed too:
    [`0.4.x` branch](.../tree/0.4.x) → [`3.x` branch](.../tree/3.x)

  Column header — slight tightening since the cell content is now a
    badge instead of a coordinate string:
    "Maven Central coordinates" → "Maven Central"

  14 rows — each "Maven Central coordinates" cell:
    [`kr.devslab:<artifact>:<version>`](sonatype-link)
      → [![Maven Central](shields.io/maven-central/v/...?...&versionPrefix=N)](sonatype-link)
    Where N = 4 for SB4 rows, N = 3 for SB3 rows. ssrf-guard rows
    use no prefix (single-line library; whatever's latest on Maven
    Central is what readers should pull).

The versionPrefix filter keeps the two easy-paging lines visually
independent — without it, the SB3 row's badge would jump to the latest
4.x patch the moment one ships.

Per-demo README "Files of interest" tables intentionally left as prose
(copy-paste-friendly Gradle snippets; #55 already aligned them with
the build files). A CI mismatch check is a follow-up if those drift
again.

Sibling PRs in the same badge sweep, already merged:
  - devslab-kr/.github#6  (org profile)
  - devslab-kr/api-log#3  (api-log doc surface for 3.0.0 renumber)

Maven Central propagation note: api-log v3.0.0 published 13:44Z,
profile badge picked it up within minutes — same auto-update behavior
will apply to these demos on the next easy-paging patch release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant