Update README - #36
Conversation
|
Warning Review limit reached
Next review available in: 39 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME content was reorganized to expand development setup and quickstart instructions, clarify authentication examples, remove the self-hosted proxy note, and document Trusted Publishing-based PyPI releases. ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@README.md`:
- Around line 293-298: Update the Releases section to document the required PyPI
Trusted Publishing publisher configuration and the GitHub pypi environment with
required reviewers. Clarify that the vX.Y.Z GitHub Release tag determines the
published version, and retain the existing workflow and no-token details.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: b11961df-b9b4-4d68-be32-2ee15eabe8c0
📒 Files selected for processing (1)
README.md
|
|
||
| ## Releases | ||
|
|
||
| Releases are published to PyPI from a GitHub Release (tag `vX.Y.Z`) by | ||
| [`.github/workflows/publish.yml`](.github/workflows/publish.yml), using | ||
| PyPI's Trusted Publishing (OIDC) — no API token is stored in this repo. No newline at end of file |
There was a problem hiding this comment.
🩺 Stability & Availability | 🟠 Major | 🏗️ Heavy lift
Document the required Trusted Publishing setup.
The publish workflow also requires a PyPI-side trusted publisher configuration and the GitHub pypi environment with required reviewers. Without those prerequisites, a maintainer can publish a GitHub Release successfully but the PyPI job cannot complete. Add these setup requirements and clarify that the vX.Y.Z release tag is the published version source.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~296-~296: The official name of this software platform is spelled with a capital “H”.
Context: ...from a GitHub Release (tag vX.Y.Z) by [.github/workflows/publish.yml](.github/workflo...
(GITHUB)
🪛 markdownlint-cli2 (0.23.1)
[warning] 298-298: Files should end with a single newline character
(MD047, single-trailing-newline)
🤖 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` around lines 293 - 298, Update the Releases section to document
the required PyPI Trusted Publishing publisher configuration and the GitHub pypi
environment with required reviewers. Clarify that the vX.Y.Z GitHub Release tag
determines the published version, and retain the existing workflow and no-token
details.
1 participant
Summary by CodeRabbit