Skip to content

docs: align README badges (drop retired Go Report Card) - #78

Merged
jackchuka merged 1 commit into
mainfrom
docs/align-readme-badges
Jul 28, 2026
Merged

docs: align README badges (drop retired Go Report Card)#78
jackchuka merged 1 commit into
mainfrom
docs/align-readme-badges

Conversation

@jackchuka

Copy link
Copy Markdown
Owner

Why

Go Report Card was sunset on 2026-07-01 and
gojp/goreportcard is now archived read-only.
The badge endpoint still returns 200 but serves a static SVG reading go report: retired,
so every README carrying it currently advertises a dead service.

While removing it, this aligns the badge block across all 20 public Go repos, which had
drifted into 3 different orders, 2 CI-badge URL forms, 3 license-badge variants, and
5 repos with no badges at all.

Canonical block

  • Test (or CI), Release, License: MIT — in that order
  • current /actions/workflows/<file>/badge.svg form, replacing the deprecated
    /workflows/<name>/badge.svg path
  • Go Reference only for repos exposing an importable public API
    (go-xcache, proto-migrate) — the other 18 keep all code in internal/
  • license badge normalized to License-MIT-blue

Every repo is MIT, has published releases, and has a test workflow, so all three
badges resolve everywhere.

Notes

  • Docs only — no code, no workflow files touched.
  • postura keeps its centered HTML badge row; gv keeps its centered layout.
  • tfpacker keeps the CI label since its workflow is ci.yml named CI.

Go Report Card was sunset on 2026-07-01 and gojp/goreportcard is archived
read-only, so the badge now renders "go report: retired". Remove it and
standardize the badge block across all public Go repos:

- Test (or CI), Release, License: MIT — in that order
- use the current /actions/workflows/<file>/badge.svg form instead of the
  deprecated /workflows/<name>/badge.svg path
- Go Reference only where an importable public API exists
- license badge normalized to License-MIT-blue, linking to the repo's own
  LICENSE rather than opensource.org
@jackchuka
jackchuka force-pushed the docs/align-readme-badges branch from 15cae8a to 5cedf2a Compare July 28, 2026 02:52
@jackchuka
jackchuka marked this pull request as ready for review July 28, 2026 03:11
@jackchuka
jackchuka merged commit 1759f2b into main Jul 28, 2026
1 check passed
@jackchuka
jackchuka deleted the docs/align-readme-badges branch July 28, 2026 03:11
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