Verify toolkit docs before publishing#1070
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 15bf213. Configure here.
| "format": "pnpm exec ultracite fix", | ||
| "prepare": "husky install", | ||
| "toolkit-docs:typecheck": "tsc --noEmit --project toolkit-docs-generator/tsconfig.json", | ||
| "toolkit-docs:test": "vitest run --root toolkit-docs-generator --config vitest.config.ts", |
There was a problem hiding this comment.
Wrong Vitest config for generator
Medium Severity
The toolkit-docs:test script passes --config vitest.config.ts from the repo root, so Vitest loads the root config instead of toolkit-docs-generator/vitest.config.ts. The CI gate therefore skips that project’s test settings (including Vitest typechecking), while toolkit-docs:typecheck excludes **/*.test.ts.
Reviewed by Cursor Bugbot for commit 15bf213. Configure here.
| run: pnpm build | ||
| working-directory: toolkit-docs-generator | ||
| - name: Validate toolkit docs generator | ||
| run: pnpm run toolkit-docs:check |
There was a problem hiding this comment.
Stale gate blocks scheduled regen
Medium Severity
The new toolkit-docs:check step runs the full generator Vitest suite, including the committed-data stale-summaries test, before generate. If toolkit-docs-generator/data/toolkits on the checked-out ref already has summaryStale: true, validation fails and the workflow never runs generation—the same path that would refresh those summaries and open the auto PR.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 15bf213. Configure here.
Run the generator's isolated type-check and test suite before publishing, and support manual verification branches without production review noise. Co-authored-by: Cursor <cursoragent@cursor.com>
15bf213 to
721b9bc
Compare
|
Current version of PR was reviewed by /review-bugbot on Jul 16, 16:06 GMT-3. It flagged 1 finding. Show 1 finding1. workflow_dispatch inputs wrongly indented
The new Bugbot on commit |


Summary
Test plan
pnpm run toolkit-docs:checkNote
Low Risk
Changes are limited to CI scripts, workflow dispatch options, and tests; production doc generation paths are unchanged aside from an earlier validation gate.
Overview
The generate toolkit docs workflow now runs
pnpm run toolkit-docs:check(TypeScript no-emit + Vitest fortoolkit-docs-generator) instead of building the generator, so broken generator code fails before doc generation and PR creation.Root
package.jsonaddstoolkit-docs:typecheck,toolkit-docs:test, andtoolkit-docs:checkso CI and local runs share the same gate.Manual workflow dispatch accepts optional
pr_branch: when set, the PR uses a[TEST]title, bases on the triggering ref, opens on that branch, and skips auto-requestingArcadeAI/engineering-tools-and-dxreviewers. Scheduled/Porter runs keep theautomation/toolkit-docsbranch and normal review behavior.Workflow markdown and workflow contract tests were updated to match (no build step; verification PR wiring).
Reviewed by Cursor Bugbot for commit 15bf213. Bugbot is set up for automated code reviews on this repo. Configure here.