fix: publish extension compatibility matrix - #760
Conversation
|
Warning Review limit reached
More reviews will be available in 45 minutes and 38 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthrough
ChangesExtension & Adapter Compatibility Matrix
Sequence Diagram(s)sequenceDiagram
participant CLI as CLI (write/check)
participant loadCatalogState
participant parseExtensionMatrix
participant generateExtensionMatrixDocs
participant writeGeneratedFile as writeGeneratedFile / driftCheck
CLI->>loadCatalogState: package-catalog.json 로드
loadCatalogState->>parseExtensionMatrix: extensionMatrix 메타데이터 전달
parseExtensionMatrix-->>loadCatalogState: ExtensionMatrixState 반환
loadCatalogState-->>CLI: CatalogState (extensionMatrix 포함)
alt write 모드
CLI->>generateExtensionMatrixDocs: ExtensionMatrixState 전달
generateExtensionMatrixDocs-->>CLI: extension-matrix.md 콘텐츠 생성
CLI->>writeGeneratedFile: extension-matrix.md 저장
CLI->>writeGeneratedFile: README Extension 섹션 저장
else check 모드
CLI->>generateExtensionMatrixDocs: ExtensionMatrixState 전달
generateExtensionMatrixDocs-->>CLI: 생성 결과 반환
CLI->>writeGeneratedFile: 기존 파일과 비교 → drift 위반 기록
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
…trix # Conflicts: # docs/package-docs-report.md
📊 Benchmark Results❌ Some benchmarks failed
Updated: 2026-06-15T01:54:13.400Z · Commit: fe71148 |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
scripts/package-docs-check.mts (1)
793-800:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winDocumentation Gate 안내가 실제 체크 범위와 불일치합니다.
현재 체크 모드는
README.md,docs/package-docs-report.md뿐 아니라packages/docs/src/content/docs/en/reference/extension-matrix.md도 드리프트 검사합니다. 안내 문구도 동일 범위를 반영해야 혼선을 줄일 수 있습니다.✏️ 제안 수정안
- "- `pnpm docs:catalog:check`는 README 카탈로그와 문서 커버리지 리포트 drift를 검증합니다.", + "- `pnpm docs:catalog:check`는 README 카탈로그, extension matrix reference 문서, 문서 커버리지 리포트 drift를 검증합니다.",🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/package-docs-check.mts` around lines 793 - 800, The Documentation Gate guidance text in the lines.push() section does not accurately reflect all files being checked for drift. Update the guidance to include all three files that are validated: README.md, docs/package-docs-report.md, and packages/docs/src/content/docs/en/reference/extension-matrix.md. Ensure the documentation text comprehensively describes the actual check scope to prevent confusion about what files are included in the drift validation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/package-docs-check.mts`:
- Around line 956-958: The `formatSmokeStatus` function returns strings that
suggest active CI smoke test execution ("entrypoint smoke + package tests" or
"entrypoint smoke only"), but the function actually only checks whether test
directories exist via `pkg.hasTests`, not actual CI/smoke test execution status.
Either rename the column and update the return strings to reflect what is
actually being checked (e.g., return "has tests" or "no tests" to indicate test
configuration presence), or modify the implementation to actually report CI
smoke test execution results. Ensure the displayed information accurately
represents whether the code checks for test directory existence versus actual
smoke test execution status.
---
Outside diff comments:
In `@scripts/package-docs-check.mts`:
- Around line 793-800: The Documentation Gate guidance text in the lines.push()
section does not accurately reflect all files being checked for drift. Update
the guidance to include all three files that are validated: README.md,
docs/package-docs-report.md, and
packages/docs/src/content/docs/en/reference/extension-matrix.md. Ensure the
documentation text comprehensively describes the actual check scope to prevent
confusion about what files are included in the drift validation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 45b2d4c1-abc2-4f72-abdc-8116e5c92102
📒 Files selected for processing (8)
.changeset/52b493b7.mdREADME.mddocs/package-catalog.jsondocs/package-docs-report.mdpackages/docs/src/content/docs/en/reference/extension-matrix.mdpackages/testing/vitest.config.tsscripts/package-docs-check.mtsscripts/tests/package-docs-check.spec.ts
Dismiss stale CodeRabbit requested-changes review: both actionable comments were addressed in d3a02a2, the remaining CodeRabbit status is a billing/rate-limit failure, and the review thread is resolved/outdated.
Fixes #625.
Summary
Croco now publishes an official generated extension and adapter compatibility matrix for provider, integration, transport, and presentation packages. The matrix is rendered into the root README and docs reference page from
docs/package-catalog.json, with required configuration, runtime support, peer dependencies, maturity, and CI smoke status shown as separate fields.변경 사항
docs/package-catalog.json.packages/docs/src/content/docs/en/reference/extension-matrix.md, and report matrix coverage by group.pnpm docs:catalog:checkpasses.@croco/docs.Verification
pnpm docs:catalog:write- passed, generated README/report/docs matrix artifacts.pnpm docs:catalog:check- passed.pnpm exec vitest run scripts/tests/package-docs-check.spec.ts --reporter verbose- passed, 5 tests.pnpm exec oxlint scripts/package-docs-check.mts scripts/tests/package-docs-check.spec.ts- passed.pnpm exec oxfmt --check scripts/package-docs-check.mts scripts/tests/package-docs-check.spec.ts- passed.pnpm --filter @croco/docs docs:build- passed and rendered/en/reference/extension-matrix/index.html; existing Typedoc/Starlight warnings only.pnpm changeset-required:check- passed before the hook-generated changeset.pnpm check- passed.git diff --cached --check- passed before commit.pnpm test && pnpm typecheck- passed sequentially.pnpm test197/197 cached tasks, and fullpnpm typecheck196/196 cached tasks.Self-review
@croco/docspatch changeset.Risk
Low. The main risk is metadata accuracy in the hand-curated matrix, but the generator now prevents new extension-group packages from silently missing matrix coverage.
Summary by CodeRabbit
릴리스 노트
새로운 기능
문서