Skip to content

docs: track apple readme badge from versions ssot - #279

Merged
hyochan merged 1 commit into
mainfrom
docs/readme-apple-badge
Aug 4, 2026
Merged

hyochan merged 1 commit into
mainfrom
docs/readme-apple-badge

Conversation

@hyochan

@hyochan hyochan commented Aug 4, 2026 •

Copy link
Copy Markdown
Member

The bug

The root README's apple version badge pinned a filter=2.* tag glob, so it
kept rendering v2.4.4 forever after the 3.x releases while the CocoaPods
badge right beside it showed v3.0.1.

The fix

The badge now reads $.apple from openiap-versions.json using the same
dynamic-json pattern the spec badge on the previous line already uses, so a
future major bump can never strand it again. Verified against the live
shields endpoint: the new badge renders v3.0.1, matching the SSOT and
the CocoaPods badge. (packages/apple/README.md uses a digit glob and is
not affected.)

Also

  • Align the kit line with the fair-use wording adopted across the repo in feat(kit): add hosted capacity guardrails #269
    ("Free for everyone." predates that change).
  • List packages/mcp-server — the section says "all OpenIAP packages" but
    omitted it.

README-only change.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added mcp-server package to the available packages list.
    • Updated Apple package badge to use dynamic version information.
    • Added fair-use safeguards information for Kit's free hosted offering.

The apple version badge pinned a `filter=2.*` tag glob, so it kept showing
v2.4.4 forever after the 3.x releases while the CocoaPods badge beside it
showed v3.0.1. It now reads `$.apple` from openiap-versions.json with the
same dynamic-json pattern the spec badge already uses, so a future major
bump can never strand it again.

Also align the kit line with the fair-use wording adopted across the repo
in #269, and list packages/mcp-server, which the "all OpenIAP packages"
section omitted.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@hyochan hyochan added 📖 documentation Improvements or additions to documentation 📝 readme labels Aug 4, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@coderabbitai

coderabbitai Bot commented Aug 4, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

README.md updates the Apple version badge, Kit’s free-use description, and the Packages list.

Changes

README package and offering updates

Layer / File(s) Summary
Update package and offering details
README.md
The Apple badge uses a dynamic version source. The Kit description mentions hosted fair-use safeguards. The Packages list includes mcp-server.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly describes the main change: updating the Apple badge in the README to use a dynamic version source from openiap-versions.json instead of a fixed filter.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-apple-badge

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.md (1)

28-28: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider adding a version or CI badge for consistency.

Every other package entry in this list (spec, google, apple, kit) includes at least one badge (CI status, version, or Maven). The new mcp-server entry has none. Add a CI or npm version badge if one is available, to keep the list visually consistent.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 28, Add a CI status or npm version badge to the mcp-server
entry in the package list, using an available badge source and matching the
badge style used by the existing spec, google, apple, and kit entries.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Line 28: Add a CI status or npm version badge to the mcp-server entry in the
package list, using an available badge source and matching the badge style used
by the existing spec, google, apple, and kit entries.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a68ed69d-4d9a-4988-b7f4-d1ce9cc35f72

📥 Commits

Reviewing files that changed from the base of the PR and between 7c53399 and 99ab6cf.

📒 Files selected for processing (1)
  • README.md

@hyochan
hyochan merged commit a04005a into main Aug 4, 2026
11 checks passed
@hyochan
hyochan deleted the docs/readme-apple-badge branch August 4, 2026 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 documentation Improvements or additions to documentation 📝 readme

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant