Skip to content

docs: use native GitHub release download totals - #168

Merged
Grivn merged 1 commit into
masterfrom
codex/native-github-download-badge
Oct 19, 2026
Merged

Grivn merged 1 commit into
masterfrom
codex/native-github-download-badge

Conversation

@Grivn

@Grivn Grivn commented Oct 19, 2026

Copy link
Copy Markdown
Member

What

Use the native Shields GitHub total-download badge in both READMEs. The total now includes all published release assets, including checksum files, with the same compact number formatting and localized labels. The npm badges are unchanged.

Remove the custom release counter, its tests, and the scheduled badge publishing workflow. The README no longer depends on the badges branch or a custom JSON endpoint.

Why

Counting every release asset makes the native badge sufficient and removes the separate data branch and refresh workflow.

Validation

Live HTTP checks of both English and Chinese badge SVGs produced:

Badge Before After
GitHub downloads 20k (packages only) 24k (all assets)
npm downloads 17k 17k

The GitHub API independently reports 23,968 downloads across 31 published releases: 19,634 archive downloads plus 4,334 checksum downloads. The fetched SVGs and comparison JSON are preserved as local verification evidence.

Checklist

  • Both localized GitHub badges render successfully through the native endpoint.
  • Both npm badge URLs and labels are unchanged and their live SVGs render successfully.
  • No references to the retired custom counter, JSON endpoint, or badge publishing branch remain in the working tree.
  • git diff --check passes.
  • User-facing impact described above: the GitHub total includes checksum downloads.

Product code is unchanged; product integration and paid live-provider suites were not rerun. Regular PR CI runs the deterministic suite.

The remote badges branch remains available for the current default-branch README until this PR is merged. It can be removed after the default branch uses the native badge and any old publishing run has finished.

Count all release assets, including checksum files, through the native Shields GitHub downloads badge. Keep the localized npm labels and compact number formatting, and remove the custom counter, its tests, and the badge publishing workflow.

Verified both localized GitHub badges change from 20k to 24k against 23,968 downloads across 31 published releases. Both npm badges still display 17k, and no references to the custom badge data remain.
@Grivn
Grivn merged commit fa74871 into master Oct 19, 2026
2 checks passed
@Grivn
Grivn deleted the codex/native-github-download-badge branch October 19, 2026 19:56
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