Skip to content

docs(readmes): badge-ify root tables (post-renumber)#59

Merged
jlc488 merged 1 commit into
mainfrom
feat/maven-central-badges-v2
May 23, 2026
Merged

docs(readmes): badge-ify root tables (post-renumber)#59
jlc488 merged 1 commit into
mainfrom
feat/maven-central-badges-v2

Conversation

@jlc488
Copy link
Copy Markdown
Contributor

@jlc488 jlc488 commented May 23, 2026

Summary

Replaced the hardcoded version strings in all 3 root-README tables (14 demo rows × 2 languages) with shields.io Maven Central badges. Plus the section headers + maintenance-branch link that #57 didn't touch.

Before After
Section header (SB4) Spring Boot 4 (\0.5.x` line)` Spring Boot 4 (\4.x` line)`
Section header (SB3) Spring Boot 3 maintenance (\0.4.x` line)` Spring Boot 3 maintenance (\3.x` line)`
Maintenance branch link [\0.4.x` branch](.../tree/0.4.x)` [\3.x` branch](.../tree/3.x)`
Column header Maven Central coordinates Maven Central
14 version cells [\kr.devslab:...:N.N.N`](sonatype)` [![Maven Central](shields.io/.../v/...?versionPrefix=N)](sonatype)

Why this PR exists (and why a second time)

This is the redo of #56, which was closed because it used 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` per the new Spring-major-aligned versioning policy), this PR finishes the badge conversion with the correct `versionPrefix=3` / `=4`.

Why per-line `versionPrefix` matters

Without the filter, the SB3 maintenance row's badge would jump to the latest `4.x` patch the moment one shipped — hiding the maintenance line's actual state. With `versionPrefix=3` on SB3 rows and `versionPrefix=4` on SB4 rows, each line independently tracks its own latest.

ssrf-guard rows use no prefix (single-line library, no SB4 fork yet).

Auto-update demonstration (already in production)

Profile badges merged 13:40Z (#6 on org `.github`). api-log v3.0.0 published to Maven Central 13:44Z (release workflow triggered by tag push). Profile's api-log badge picked up the new version within minutes — zero manual README edits required.

Same behavior will apply here on the next easy-paging patch release.

What's NOT in this PR

Test plan

  • CI green (root README isn't built; this is doc-only)
  • Render the README on GitHub and confirm all 14 badges show expected versions (4× `4.0.0` SB4, 4× `3.0.0` SB3 — both renumbered; 6× `3.1.0` ssrf-guard family)
  • Click each badge → lands on Maven Central artifact page
  • After next easy-paging release, badges auto-update without a doc commit

…nded

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