ci(required): add content-guard deletion floor for generated SDK docs - #112
Conversation
The SDK auto-doc pipeline clears its target dir before copying fresh output, so a failed or partial generation silently deletes a package's published docs — and broken-links stays green because the dropped pages leave the nav too. This session hit exactly that: a doc-gen run that dropped 8 TypeScript packages passed every check. Adds a required content-guard job that fails a PR deleting more than 20 sdks/** doc pages, with a docs:bulk-change label to opt out of deliberate restructures. A backstop independent of the generator itself. From uncommitted work on fix/api-docs-partial-failure-guard; rebased onto main and wired into the existing required gate.
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
Warning Review limit reached
Next review available in: 30 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: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✨ 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 |
Why
The SDK auto-doc pipeline clears its target directory before copying freshly generated output. So when generation fails or is partial, it silently deletes a package's published docs — and the
broken-linkscheck stays green, because the dropped pages leave the nav at the same time (no dangling links).This session hit exactly that failure mode: a TypeScript doc-gen run dropped 8 packages and passed every check. It was only caught by manual coverage inspection after merge.
What this adds
A required
content-guardjob (the "deletion floor"): if a PR deletes more than 20sdks/**doc pages versus the base, it fails. Deliberate bulk restructures opt out with adocs:bulk-changelabel. It's wired into the existingrequiredgate.This is a backstop independent of the generator — it catches the regression regardless of which SDK pipeline or which failure mode produced the deletion.
Provenance
This was written as uncommitted work on the
fix/api-docs-partial-failure-guardbranch (the branch name says it all) but never landed, so it never protectedmain. Rebased onto current main and wired into therequiredjob. A companion PR adds the matching abort-on-failure guard inside the TypeScript template itself.Test plan
requiredcheck still gates correctly with the newneedsentrysdks/**/*.mdand confirm the guard fails, then thatdocs:bulk-changeclears it