Show a release and build badge for each language, not just Python - #9
Merged
Merged
Conversation
The site's home page carried four badges, all of them pointing at idfkit/idfkit. A site whose premise is that two libraries hold the same standing over every page should not advertise one of them and omit the other. The row is now symmetric: a release and a build badge per language, plus the licence. The TypeScript release badge filters on v*, because the newest GitHub release in idfkit-js is docs-2026.3, a documentation artifact rather than a library version, and shields would otherwise report that as the version. Labels move into the URL, since alt text does not reach a rendered shield. Commit activity is gone rather than duplicated: five badges is a full row, and it said the least of the four. Two badges linked to img.shields.io instead of to the thing they described; both now link somewhere a reader can use. The README had no badges at all, so it gains the row idfkit's own README uses: both library releases, this repository's docs build, its licence.
Contributor
|
Docs preview for this PR is available at: Changed pages: |
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
1 participant
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.
The home page carried four badges and all four pointed at
idfkit/idfkit. A site whose premise is that two libraries hold the same standing over every page should not advertise one of them and omit the other.The row, before and after
idfkit)idfkit)idfkit)idfkit)Three things worth reviewing
The TypeScript release badge filters on
v*. The newest GitHub release inidfkit-jsisdocs-2026.3, a documentation artifact rather than a library version, so an unfiltered badge reportsdocs-2026.3as the version of the library. With the filter it reportsv0.2.0.Labels are set in the URL. A shield does not read the Markdown alt text, so
?label=python%20releaseis what makes the two releases distinguishable.Commit activity is gone rather than duplicated. Five badges is already a full row and it said the least of the four. Easy to restore on both sides if you would rather keep it.
Two of the old badges linked to
img.shields.iorather than to the releases or the licence they described. Both now link somewhere a reader can use.The README had no badges at all, so it gains the row
idfkit's own README uses: both library releases, this repository's own docs build, its licence.A judgment call left open
The Python release badge reads
v0.15.0while the site is pinned to build against1.0.0-rc.3, because the1.0.0line is all pre-releases. Adding&include_prereleasesto both badges would showv1.0.0-rc.3andv0.3.0-rc.2instead. That is a question about what the home page should advertise during a release candidate, so I kept the existing stable-only rule rather than change it silently.Checks
python release: v0.15.0,python build: passing,typescript release: v0.2.0,typescript build: passing,docs: passing,license: MIT.make checkpasses.index.htmlcarries all five badges, with&escaped correctly.make docs-testfails locally at 108 warnings, identically on a stashed baseline: a missing locallibcairothat the social-card plugin wants, untouched by this change. CI has the library.