Skip to content

docs(profile): drop verbose label= from ssrf-guard / api-log badges#9

Merged
jlc488 merged 1 commit into
mainfrom
feat/simplify-badge-labels
May 23, 2026
Merged

docs(profile): drop verbose label= from ssrf-guard / api-log badges#9
jlc488 merged 1 commit into
mainfrom
feat/simplify-badge-labels

Conversation

@jlc488
Copy link
Copy Markdown
Contributor

@jlc488 jlc488 commented May 23, 2026

Summary

Follow-up to #6 — matches the label simplification just applied to the still-open badge PRs:

User flagged that `?label=kr.devslab%3A` makes the badge's left side too long, shrinking the version text on the right.

Changes

Library Before After
ssrf-guard `?label=kr.devslab%3Assrf-guard` (long) default `Maven Central` label (compact)
api-log `?label=kr.devslab%3Aapi-log-*` (long) default `Maven Central` label (compact)
easy-paging `?label=Spring%20Boot%204` + `?label=SB3%20maintenance` kept as-is

Why easy-paging keeps its labels

The easy-paging entry is the only one with two badges on the same line (SB4 active + SB3 maintenance). Without a distinguishing label they'd both render as just "Maven Central | X.Y.Z" — readers couldn't tell which is which without clicking through. The current labels `Spring Boot 4` / `SB3 maintenance` are short enough that the version text still reads cleanly.

Single-badge rows (ssrf-guard, api-log) don't have this ambiguity → default label is fine.

Why the artifact ID being redundant is OK

  • The library name and link sit immediately to the left of the badge
  • Clicking the badge lands on the Maven Central artifact page with the full coordinate
  • The artifact ID inside the badge label was duplicating information that's already visible

Test plan

  • Render the org page (https://github.com/devslab-kr) and confirm:
    • ssrf-guard row: `Maven Central | 3.1.0` (compact, version readable)
    • easy-paging row: `Spring Boot 4 | 4.0.0` · `SB3 maintenance | 3.0.0` (both labels visible, both versions readable)
    • api-log row: `Maven Central | 3.0.0` (compact, version readable)

Follow-up to #6 — matches the label-simplification pattern just applied
to devslab-examples#59 (badge labels) and the easy-paging starter docs
PR. User flagged that the long `label=kr.devslab:<artifact>` made the
version text render small.

Changes:
  - ssrf-guard badge: drop `?label=kr.devslab%3Assrf-guard`
                      → default "Maven Central | 3.1.0" rendering
  - api-log-core badge: drop `?label=kr.devslab%3Aapi-log-*`
                      → default "Maven Central | 3.0.0" rendering
                      (api-log was renumbered 0.6.0 → 3.0.0; badge
                       picked it up automatically — proving the auto-
                       update value of the badge pattern)

  - easy-paging easy-paging dual badge: KEEPS the short labels
    `Spring Boot 4` / `SB3 maintenance`. Reason: that entry has TWO
    badges side-by-side on the same line — without a distinguishing
    label, readers can't tell which is the SB4 line and which is the
    SB3 maintenance line. The labels are short enough that the
    version text still renders at a readable size.

Trade-off captured: the rule "default label" is broken for the
dual-badge case in favor of "label that distinguishes the two side-by-
side badges." Single-badge entries take the default; entries with
ambiguity get a short discriminator.

Both languages updated symmetrically.
@jlc488 jlc488 merged commit 3de2636 into main May 23, 2026
jlc488 added a commit to devslab-kr/devslab-examples that referenced this pull request May 25, 2026
…readability) (#63)

Per user feedback — when a badge's left side reads
'kr.devslab:easy-paging-spring-boot-starter' (the full coordinate),
shields.io has to fit a lot of pixels into the badge image, and the
version on the right ends up rendered too small to read at normal page
zoom. Dropping the label= parameter lets shields.io fall back to its
default 'Maven Central' tag, which is short enough that the version
glyphs render at a comfortable size.

Information loss is zero: every row's first column already shows the
demo name (which uniquely identifies the library), and the badge link
target is the artifact's Maven Central page. The coordinate is one
click away when a reader actually needs to copy it.

Applied across all 19 rows (4 easy-paging SB4 + 4 easy-paging SB3
maintenance + 8 ssrf-guard + 3 api-log). versionPrefix=3 / =4 filters
on the easy-paging rows are preserved — they keep the SB3 maintenance
line visually independent from the SB4 active line so the SB3 row
doesn't jump to the latest 4.x patch the moment one ships.

Same pattern as the profile README at devslab-kr/.github#9 — keeping
the two surfaces consistent.
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