docs(readme): add self-updating version badge, de-stale alpha prose - #1349
Merged
Conversation
Adds a shields.io `github/package-json/v` badge to the README badge block that reads the version from the root package.json — release-please bumps that field on every Release-PR merge, so the badge tracks the release line (0.1.0 today, 0.1.1 when #1345 merges) with zero README edits and no hardcoded number in the markdown. Chose package-json/v over v/release so it renders correctly right now, independent of when the v0.1.0 GitHub Release is published. Keeps the low-churn `Status: alpha` badge as-is (maturity axis, not version) and drops the now-stale "First public release is in progress" prose so it can't re-drift. Closes #1346 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Piotr Swierzy <piotr.swierzy@blockydevs.com>
norbert-kulus-blockydevs
pushed a commit
that referenced
this pull request
Jul 22, 2026
…1349) Adds a shields.io `github/package-json/v` badge to the README badge block that reads the version from the root package.json — release-please bumps that field on every Release-PR merge, so the badge tracks the release line (0.1.0 today, 0.1.1 when #1345 merges) with zero README edits and no hardcoded number in the markdown. Chose package-json/v over v/release so it renders correctly right now, independent of when the v0.1.0 GitHub Release is published. Keeps the low-churn `Status: alpha` badge as-is (maturity axis, not version) and drops the now-stale "First public release is in progress" prose so it can't re-drift. Closes #1346 Signed-off-by: Piotr Swierzy <piotr.swierzy@blockydevs.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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 & why
The README badge block (CI / License / Status) had no version badge — a reader couldn't tell which release OpenLinker is on. Hardcoding
v0.1.0would be the wrong fix: it'd go stale the instant the next release cuts and the README is the one place nobody remembers to update (the exact drift class we closed with the release-please work in #1332).This adds a dynamic shields.io badge that reads the version from the single canonical source, so it can't drift:
github/package-json/vreadsversionfrom the rootpackage.json— which release-please bumps only when a Release PR merges. So the badge tracks the release line (0.1.0today;0.1.1the moment chore(main): release 0.2.0 #1345 merges) with zero README edits and no hardcoded number in the markdown.package-json/vovergithub/v/releaseso it renders correctly right now, independent of when thev0.1.0GitHub Release is published (thev/releasevariant shows "no releases" until then).Two axes handled by churn rate:
Status: alphabadge is left untouched — it changes ~twice in the project's life and is correctly hardcoded.Also de-staled the prose at line 13 — dropped "First public release is in progress" (
v0.1.0is now tagged) and kept it maturity-only/version-agnostic so it can't re-drift.Diff
README.mdonly, +2/−1: one new badge line + one prose trim. No app code, no tests, no migration.Test plan
pnpm check:invariantsgreen — incl.scripts/check-repo-urls.mjs(the new shields URL uses the canonicalopenlinker-project/openlinkerslug and trips no repo-URL guard).Status: alphabadge + its#670link unchanged.package.json.package.json, which release-please updates on Release-PR merge — verify after chore(main): release 0.2.0 #1345 merges (→0.1.1) with no README change.Closes #1346
🤖 Generated with Claude Code