Skip to content

docs(xtask): generate and validate crate support matrix from workspace metadata#384

Merged
EffortlessSteven merged 3 commits intomainfrom
codex/define-crate-support-matrix-and-metadata-2xvq84
Mar 30, 2026
Merged

docs(xtask): generate and validate crate support matrix from workspace metadata#384
EffortlessSteven merged 3 commits intomainfrom
codex/define-crate-support-matrix-and-metadata-2xvq84

Conversation

@EffortlessSteven
Copy link
Copy Markdown
Member

Motivation

  • Provide a single source-of-truth crate-by-crate support contract so consumers know which crates are intended for public use vs internal/test-only adapters.
  • Automate generation and validation so the matrix cannot drift from workspace state and CI will catch inconsistencies.

Description

  • Add a support_matrix section to docs/metadata/workspace-docs.json describing per-crate fields: support_tier, publish_status, facade_exposed, semver_expectation, msrv_policy, intended_audience, and optional replacement_path / deprecation_note.
  • Extend xtask docs sync to render and validate the support matrix: xtask/src/docs_sync.rs now reads support_matrix, validates enum values and illegal combinations (e.g. test-only must be repo-internal, facade_exposed incompatible with repo-internal), ensures completeness against the Cargo workspace, and writes docs/reference/support-matrix.md (generated from metadata).
  • Integrate the docs-sync step into CI and gate flows by invoking docs_sync::docs_sync_cmd(true) in xtask/src/main.rs so metadata drift fails automation.
  • Add unit tests for rendering/consistency and validation in xtask/src/docs_sync.rs and add the generated docs/reference/support-matrix.md file; update README.md and docs/how-to/release.md to reference the support matrix.

Testing

  • Ran cargo xtask docs-sync to generate docs/reference/support-matrix.md and confirmed it wrote the file successfully. (Succeeded.)
  • Ran cargo xtask docs-sync --check to verify no drift between metadata and generated docs; command returned success in CI-like check. (Succeeded.)
  • Ran unit tests for xtask with cargo test -p xtask, which executed the new snapshot/validation tests; all tests passed (98 passed, 0 failed). (Succeeded.)

Codex Task

@gemini-code-assist
Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 28, 2026

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 23 minutes and 40 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 23 minutes and 40 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: fed71f37-e073-4db7-96f9-79814a4b9cb2

📥 Commits

Reviewing files that changed from the base of the PR and between 449adfa and d4db0d1.

📒 Files selected for processing (7)
  • README.md
  • docs/how-to/publishing.md
  • docs/how-to/release.md
  • docs/metadata/workspace-docs.json
  • docs/reference/support-matrix.md
  • xtask/src/docs_sync.rs
  • xtask/src/main.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/define-crate-support-matrix-and-metadata-2xvq84

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 and usage tips.

@EffortlessSteven EffortlessSteven merged commit f0fc4ab into main Mar 30, 2026
4 checks passed
@EffortlessSteven EffortlessSteven deleted the codex/define-crate-support-matrix-and-metadata-2xvq84 branch March 30, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant