Skip to content

ci(release): auto-bump README version badges + make them static - #8

Merged
katipally merged 1 commit into
mainfrom
ci/readme-auto-version
Jun 9, 2026
Merged

ci(release): auto-bump README version badges + make them static#8
katipally merged 1 commit into
mainfrom
ci/readme-auto-version

Conversation

@katipally

Copy link
Copy Markdown
Owner

Why

After v2.7.2 shipped, the README's macOS version badges looked stale. Root cause: they were dynamic shields.io GitHub badges that intermittently render Unable to select next GitHub token from pool when shields' GitHub-API token pool is rate-limited. The data was correct (latest release is v2.7.2) but the render flapped.

What

  • The two macOS version badges (top release + the download-tile latest) are now static shields badges with the literal version — no external-API dependency, so they can never flap.
  • release.yml rewrites that version in the same commit that pushes the version bump + appcast.xml, so the README always matches the release just published. README.md is added to the staged file list.
  • iOS keeps its dynamic App Store badge — that's a separate release pipeline the bot doesn't drive.
  • Live repo-stat badges (Downloads, Stars, CI) stay dynamic + cached — they change between releases, so static wouldn't fit.

Verified: static badges render cleanly, and the sed bump correctly rewrites v2.7.2 → vNEXT.

🤖 Generated with Claude Code

The macOS 'release' and 'latest' badges were dynamic shields.io GitHub
endpoints, which intermittently render 'Unable to select next GitHub
token from pool' during shields' API rate-limit windows — so the README
appeared not to update after a release. Make them static badges with the
literal version baked in, and have the release bot rewrite that version
in the same commit that pushes the version bump + appcast.xml. Now the
README always matches the published release with zero external-API
dependency. iOS keeps its dynamic App Store badge (separate pipeline).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation ci CI, workflows, or repo tooling labels Jun 9, 2026
@katipally
katipally merged commit 596fdec into main Jun 9, 2026
5 checks passed
katipally added a commit that referenced this pull request Jun 13, 2026
ci(release): auto-bump README version badges + make them static
katipally added a commit that referenced this pull request Aug 4, 2026
ci(release): auto-bump README version badges + make them static
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci CI, workflows, or repo tooling documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant