Skip to content

docs: refresh release badges - #3

Merged
ajaysurya1221 merged 1 commit into
mainfrom
docs/refresh-release-badges
Jul 20, 2026
Merged

docs: refresh release badges#3
ajaysurya1221 merged 1 commit into
mainfrom
docs/refresh-release-badges

Conversation

@ajaysurya1221

@ajaysurya1221 ajaysurya1221 commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • add bounded Shields cache controls to the PyPI and Python badges
  • force GitHub Camo to replace its pre-release package or version not found snapshots

Direct badge endpoints already report v0.1.0 and Python 3.10–3.14. This changes README presentation only; release code, tag, and immutable artifacts are untouched.

Summary by CodeRabbit

  • Documentation
    • Improved README badge freshness by enabling periodic caching for PyPI version and supported Python version badges.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3c012e44-1df4-4b59-b746-852e24d0273a

📥 Commits

Reviewing files that changed from the base of the PR and between 42a6523 and 6642e3e.

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

📝 Walkthrough

Walkthrough

The README’s PyPI and supported Python version Shields.io badge URLs now include cacheSeconds=300. No other README content or public declarations changed.

Changes

README badge updates

Layer / File(s) Summary
Configure badge caching
README.md
Adds a 300-second Shields.io cache duration to the PyPI-related badge URLs.

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

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the summary but omits required boundary/compatibility, evidence/testing, and checklist sections from the template. Add the missing Boundary and compatibility, Evidence and testing, and Checklist sections, including any relevant test evidence.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the README badge update and is specific enough for history browsing.
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/refresh-release-badges

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.

@ajaysurya1221
ajaysurya1221 merged commit cdf51d3 into main Jul 20, 2026
14 checks passed
@ajaysurya1221
ajaysurya1221 deleted the docs/refresh-release-badges branch July 20, 2026 13:54
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