Skip to content

ci(required): add content-guard deletion floor for generated SDK docs - #112

Merged
WomB0ComB0 merged 2 commits into
mainfrom
ci/content-deletion-guard
Jul 28, 2026
Merged

ci(required): add content-guard deletion floor for generated SDK docs#112
WomB0ComB0 merged 2 commits into
mainfrom
ci/content-deletion-guard

Conversation

@WomB0ComB0

Copy link
Copy Markdown
Member

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-links check 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-guard job (the "deletion floor"): if a PR deletes more than 20 sdks/** doc pages versus the base, it fails. Deliberate bulk restructures opt out with a docs:bulk-change label. It's wired into the existing required gate.

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-guard branch (the branch name says it all) but never landed, so it never protected main. Rebased onto current main and wired into the required job. A companion PR adds the matching abort-on-failure guard inside the TypeScript template itself.

Test plan

  • This PR deletes 0 SDK pages → guard passes
  • Confirm the required check still gates correctly with the new needs entry
  • (Optional) open a throwaway PR deleting >20 sdks/**/*.md and confirm the guard fails, then that docs:bulk-change clears it

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.
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@github-actions github-actions Bot added the area:ci GitHub Actions, workflows, CI label Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@WomB0ComB0, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 30 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dea5f373-a7f4-4143-9025-07346801a815

📥 Commits

Reviewing files that changed from the base of the PR and between 7560c35 and 2089961.

📒 Files selected for processing (1)
  • .github/workflows/required.yml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ci/content-deletion-guard

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.

@WomB0ComB0
WomB0ComB0 merged commit a371b15 into main Jul 28, 2026
13 checks passed
@WomB0ComB0
WomB0ComB0 deleted the ci/content-deletion-guard branch July 28, 2026 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:ci GitHub Actions, workflows, CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants