ci(docs): docs-gates workflow + DOCS_MAP generator (split 1/4 of #1317)#1462
ci(docs): docs-gates workflow + DOCS_MAP generator (split 1/4 of #1317)#1462SharedQA wants to merge 2 commits into
Conversation
…tructorfabric#1317) Split out of constructorfabric#1317 per review (too big to review as one). This is the docs slice: - .github/workflows/docs-gates.yml — presence (PRD+DESIGN), template conformance, artifacts.toml mapping, and a fresh DOCS_MAP.md gate; waivers via docs/.docs-gate-waivers (reason+expiry). - scripts/ci/docs_map.py — the generator/checker. - docs/DOCS_MAP.md (regenerated against current main), docs/.docs-gate-waivers. The CI step runs 'python3 scripts/ci/docs_map.py --check' directly (instead of 'make docs-check') so this PR carries no Makefile — the dev-loop Makefile stays in the constructorfabric#1317 release slice; the command is identical, so zero CI/local drift. No other concern (security/helm/release) is touched here. Signed-off-by: Kenan Salim <ks@constructor.tech>
|
Warning Review limit reached
More reviews will be available in 56 minutes and 57 seconds. Learn how PR review limits work. To continue reviewing without waiting, enable usage-based billing in the billing tab. ⌛ How to resolve this issue?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 credits. 🚦 How do rate 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 see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ 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 |
… (split 4/4) Per review, constructorfabric#1317 was too big (docs/security/helm/release). The other three concerns moved to dedicated PRs: - docs-gates -> constructorfabric#1462 - security-gates -> constructorfabric#1463 - helm-validate -> constructorfabric#1464 constructorfabric#1317 now carries only the release/quality slice: - .github/workflows/release-train.yml (version/publish train) - .github/workflows/backend-checks.yml (coverage ratchet folded in) - .github/workflows/e2e-bronze-to-api.yml (coverage note) - scripts/ci/enforce-quality-gates.sh (required-checks bootstrap) - Makefile (the local dev-loop aggregator) Merge order: this slice lands LAST. The Makefile's aggregate targets (check/ci-pr) and the enforce script reference the gates that now live in Signed-off-by: Kenan Salim <ks@constructor.tech> constructorfabric#1462/constructorfabric#1463/constructorfabric#1464, so they resolve once those merge to main and this rebases.
Split out of #1317 (which is too large to review as one — docs / security / helm / release). This is the docs slice.
What
.github/workflows/docs-gates.yml— blocking docs gate: every component/domain hasspecs/PRD.md+specs/DESIGN.md, they follow the canonical template, are registered incypilot/config/artifacts.toml, anddocs/DOCS_MAP.mdis fresh. Exceptions viadocs/.docs-gate-waivers(reason + expiry).scripts/ci/docs_map.py— the map generator +--check.docs/DOCS_MAP.md(regenerated against current main),docs/.docs-gate-waivers.Notes
python3 scripts/ci/docs_map.py --checkdirectly (notmake docs-check), so this PR carries no Makefile — that stays in the ci: release train + coverage ratchet (release slice; split from the omnibus) #1317 release slice. Same command, zero CI/local drift.