docs: migrate README badges from badgen to shields.io#264
Merged
Conversation
badgen.net's `github/checks` endpoint has been returning HTTP 500, breaking the build status badge. Rather than fix that one badge in isolation, move all five badges to shields.io for a consistent provider and visual style. shields.io is actively maintained (Badges Foundation) and has a much larger pool of GitHub API tokens than badgen, which makes it considerably more reliable for the Actions-status badge in particular. All badges use `style=flat` to match badgen's previous look. Colors (`ff80ff`, `cyan`) and icons (`github`, `codecov`) are preserved. The build badge link target is also corrected to point at the workflow runs page rather than the repo root. Made-with: Cursor
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #264 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 100 100
Branches 14 14
=========================================
Hits 100 100 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Replace `npm/dt` (an undocumented badgen-compat redirect on shields.io) with `npm/d18m`, which is the canonical documented endpoint for recent-window downloads. Functionally identical -- shields was already 301'ing dt -> d18m -- but the URL is now self-documenting. - Update the badge alt text to "18mo Downloads" so it accurately reflects the 18-month window (the previous "Total Downloads" was carried over from badgen's all-time semantics, which shields doesn't expose). - Switch all five badges to `style=for-the-badge` for a more visually prominent treatment, applied uniformly across the row. Made-with: Cursor
arb
force-pushed
the
chore/badges-to-shields
branch
from
bd9819f to
c03157f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Move all five README badges from
badgen.nettoimg.shields.io, all usingstyle=flat.Why
The build-status badge had been showing
500becausebadgen.net'sgithub/checksendpoint is currently returning HTTP 500. That endpoint depends on an authenticated GitHub API token that badgen has to maintain server-side, and it's been intermittently broken for a while. badgen.net itself is also effectively unmaintained at this point.The other badgen badges (
npm/v,codecov/c,npm/dt) still work fine because they hit public unauthenticated APIs, but rather than leave a mixed setup where one provider is partially broken, this PR moves the whole row to a single, actively-maintained provider so they fail or succeed together.How
Each badge image URL is swapped for its shields.io equivalent. Link targets are unchanged except for the build badge, which now correctly points at the Actions workflow runs page instead of the repo root. Colors (
ff80ff,cyan) and icons (github,codecov) are preserved. All five badges sharestyle=flatso the row is visually consistent.shields.io's
flatand badgen'sflataren't pixel-identical, but they're very close, and having all five badges from the same provider with the same style parameter is the bigger consistency win.