Skip to content

ci(docs): docs-gates workflow + DOCS_MAP generator (split 1/4 of #1317)#1462

Closed
SharedQA wants to merge 2 commits into
constructorfabric:mainfrom
SharedQA:claude/split-docs-gates
Closed

ci(docs): docs-gates workflow + DOCS_MAP generator (split 1/4 of #1317)#1462
SharedQA wants to merge 2 commits into
constructorfabric:mainfrom
SharedQA:claude/split-docs-gates

Conversation

@SharedQA

Copy link
Copy Markdown
Contributor

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 has specs/PRD.md+specs/DESIGN.md, they follow the canonical template, are registered in cypilot/config/artifacts.toml, and docs/DOCS_MAP.md is fresh. Exceptions via docs/.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

…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>
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@SharedQA, we couldn't start this review because you've reached your PR review rate limit.

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 @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 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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cb851ac4-d6f7-4e50-9a74-f5684eaab51f

📥 Commits

Reviewing files that changed from the base of the PR and between bf8a620 and 5c0dcec.

📒 Files selected for processing (4)
  • .github/workflows/docs-gates.yml
  • docs/.docs-gate-waivers
  • docs/DOCS_MAP.md
  • scripts/ci/docs_map.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

SharedQA pushed a commit to SharedQA/insight that referenced this pull request Jun 23, 2026
… (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.
@SharedQA
SharedQA marked this pull request as ready for review June 24, 2026 15:02
@SharedQA
SharedQA requested a review from a team as a code owner June 24, 2026 15:02
@ktursunov ktursunov closed this Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants