fix(action): shorten the description under the Marketplace 125-char cap#75
Conversation
The GitHub Marketplace rejects an action whose description is 125+ chars. Keep the hook-vs-required-check rationale as a comment and ship a 119-char description that leads with the same hook.
|
Warning Review limit reached
Next review available in: 41 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. ✨ 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 |
What & why
Publishing the Action to the GitHub Marketplace fails validation: "Description must be less than 125 characters." Ours was ~250.
New description (119 chars, validated by parsing the YAML):
The full rationale (hooks can be skipped with
--no-verify; a required check cannot) stays as a comment above the field.Note for publishing
Marketplace validation reads
action.ymlfrom the tagged commit, and thev1.0.0tag carries the old long description — so after merging, publish the Action by checking the Marketplace box on the next release (e.g.v1.0.1/v1.1.0), not by editingv1.0.0.Test plan
yaml.safe_loadparses; folded description = 119 chars < 125.