Badge row: clones, downloads and fuzz added; pyversions, ruff and mypy dropped - #2
Merged
Conversation
…nd mypy dropped render_badges.py is the source of the README's row; this is the list, the render under generated/, and the docstring's reasons. Stars stay out. The two adoption counts name what they measure and link to the data: downloads is pypistats per month, an upper bound because mirrors and CI install too; clones is summed from clones-history.json on the badges branch, which ctrlrun/.github/workflows/traffic.yml writes daily from the traffic API, and this repository's own CI is in that figure because actions/checkout is a clone. fuzz is the workflow test_fuzzing already requires. pypi/pyversions, ruff and mypy --strict are removed, and the docstring says why and that scripts/check.sh still enforces what the two static ones asserted. links.py resolved blob/badges/... against the worktree and called the clones receipt broken; a ref no checkout holds is now skipped, with a test that also requires a missing path on main to stay broken.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe badge row adds clone, download, and fuzz badges and removes several existing badges. The documentation link auditor now skips absolute GitHub links that target the detached ChangesBadge rendering and audit behavior
Priority: ⬇️ Low Estimated code review effort: 3 (Moderate) | ~20 minutes Change: Feature Sequence Diagram(s)sequenceDiagram
participant BadgeRenderer
participant DocsAudit
participant GitHubResolver
BadgeRenderer->>DocsAudit: Emit badge links
DocsAudit->>GitHubResolver: Resolve GitHub URL ref
GitHubResolver-->>DocsAudit: Skip badges ref
GitHubResolver-->>DocsAudit: Report missing main path
Merge Risk: ⚪ Minimal · up to The badge updates and detached-reference handling are covered by the updated audit behavior and tests, with no unresolved merge risk identified. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 2📝 Generate docstrings 💡
🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
arpanghoshal
added a commit
to CTRLRun/ctrlrun
that referenced
this pull request
Sep 11, 2026
…y dropped (#137) The row generated in ctrlrun-docs, the test that pins it, and the workflow behind the one number this repository produces itself. clones has no public source: the traffic API needs push access and keeps fourteen days. traffic.yml reads it daily with TRAFFIC_TOKEN, merges each day into clones-history.json on the badges branch by date (assignment, not addition, so a re-run cannot double-count), and writes clones-badge.json from the sum. Absent the secret it warns and exits 0. actions/checkout is a git clone, so this repository's own CI is in the figure, and the generator's docstring says so. downloads is pypistats per month, an upper bound. fuzz is the workflow test_fuzzing already requires on every push. Removed: pypi/pyversions, ruff and mypy --strict. scripts/check.sh still runs all three and CI still has to call it; the test now requires their absence so a row that grew back fails. Review raised that traffic.yml and the badge job in ci.yml both publish to the badges branch unserialized. Both now share the badges-branch concurrency group, and traffic.yml retries by re-applying its days onto the newer head. Generator and link-checker fix: CTRLRun/ctrlrun-docs#2.
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
1 participant
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.
What
The generator behind the README badge row (companion to CTRLRun/ctrlrun#137, which carries the paste), and a link-checker fix the new row needed.
Row: clones · pypi · downloads · docs · CI · CodeQL · fuzz · tests · CTRLRun verified · Scorecard · license
Changes
tools/docs_audit/render_badges.py:Clones(shields endpoint on thebadgesbranch, linked toclones-history.json),Downloads(pypistats, per month) andFuzz(the existing workflow) added;Python versions,Ruffandmypy --strictremoved. The docstring records why, what each count measures, and thatscripts/check.shstill enforces what the two static badges asserted. Stars stay out.tools/docs_audit/links.py:blob/<ref>/<path>was resolved against the worktree for every ref, so the clones receipt on the orphanbadgesbranch was reported broken. Refs no checkout holds are now skipped; a missing path onmainstill fails.tests/test_docs_audit.py: the test for that, both halves.generated/badges.readme.md: regenerated.Checks
Full docs suite: 1575 passed.
render_badges.py --checkclean against the README in CTRLRun/ctrlrun#137. ruff format and check clean.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Updates
Bug Fixes