docs(ci): version badges, Publish status, and aggregate downloads badge - #30
Merged
Merged
Conversation
Extends the Packages table with a Canary column alongside the existing Stable one, so every package's current canary version is visible at a glance and stays live (shields.io npm dist-tag badges pull straight from the registry, no manual updates needed). Also adds a Publish workflow-status badge to the header row next to the existing CI badge. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv
Adds a daily (+ manually dispatchable) workflow that computes all-time npm download totals across all 6 published packages, chunking date ranges to stay under npm's ~18-month-per-request cap, and commits the result as shields.io endpoint-badge JSON to a dedicated `badges` branch rather than `main` — keeps generated data out of main's history and off to the side of branch protection. Adds a "Total Downloads" badge to the README header pointing at that endpoint. First data point requires either the next scheduled run or a manual "Run workflow" dispatch after this merges. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv
shashikanth-gs
changed the title
shashikanth-gs
pushed a commit
that referenced
this pull request
Aug 12, 2026
The downloads-badge.yml workflow added in #30 never registered with GitHub Actions — missing from both the workflows list and the Actions UI, unlike every other workflow file in this repo. The one structural difference: it embedded a fairly complex multi-line Node script (backticks, nested template literals, comments) directly inside a YAML block scalar, unlike ci.yml/publish.yml/version.yml, which all use simple single-line `run:` commands. Move the script to scripts/downloads-badge.mjs and reduce the workflow step to `run: node scripts/downloads-badge.mjs`, removing that whole class of risk regardless of whether it was the actual root cause. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv
3 tasks
shashikanth-gs
added a commit
that referenced
this pull request
Aug 12, 2026
The downloads-badge.yml workflow added in #30 never registered with GitHub Actions — missing from both the workflows list and the Actions UI, unlike every other workflow file in this repo. The one structural difference: it embedded a fairly complex multi-line Node script (backticks, nested template literals, comments) directly inside a YAML block scalar, unlike ci.yml/publish.yml/version.yml, which all use simple single-line `run:` commands. Move the script to scripts/downloads-badge.mjs and reduce the workflow step to `run: node scripts/downloads-badge.mjs`, removing that whole class of risk regardless of whether it was the actual root cause. Claude-Session: https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv Co-authored-by: Claude <noreply@anthropic.com>
col
pushed a commit
to col/a2a-wrapper
that referenced
this pull request
Aug 19, 2026
…ge (shashikanth-gs#30) * docs: add canary version badges and Publish workflow status to README Extends the Packages table with a Canary column alongside the existing Stable one, so every package's current canary version is visible at a glance and stays live (shields.io npm dist-tag badges pull straight from the registry, no manual updates needed). Also adds a Publish workflow-status badge to the header row next to the existing CI badge. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv * feat(ci): add scheduled workflow for aggregate downloads badge Adds a daily (+ manually dispatchable) workflow that computes all-time npm download totals across all 6 published packages, chunking date ranges to stay under npm's ~18-month-per-request cap, and commits the result as shields.io endpoint-badge JSON to a dedicated `badges` branch rather than `main` — keeps generated data out of main's history and off to the side of branch protection. Adds a "Total Downloads" badge to the README header pointing at that endpoint. First data point requires either the next scheduled run or a manual "Run workflow" dispatch after this merges. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv --------- Co-authored-by: Claude <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
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.
Summary
Follow-up to #29. Adds three things to make the release pipeline's state visible at a glance from the README.
Change
img.shields.io/npm/v/<pkg>and.../<pkg>/canary) — no manual updates needed.downloads-badge.ymlruns daily (+ manual dispatch) and computes all-time npm download totals across all 6 packages — chunking date ranges to stay under npm's ~18-month-per-request cap — then commits the result as shields.io endpoint-badge JSON to a dedicatedbadgesbranch (kept separate frommainon purpose, so generated data doesn't pollute main's history or need to bypass branch protection). The README badge points at the raw file on that branch.Manual follow-up
The
badgesbranch doesn't exist yet, so the Total Downloads badge will show "invalid" until the workflow runs once. Either wait for the next scheduled run (daily, 06:00 UTC) or trigger it manually from the Actions tab (Downloads Badge → Run workflow) right after this merges.Test plan
downloads-badge.ymlonce and confirm thebadgesbranch is created with.github/badges/downloads.json+downloads-detail.json🤖 Generated with Claude Code
https://claude.ai/code/session_01ErQ6uTpLp3HE5yVTyq6fwv