Skip to content

Verify toolkit docs before publishing#1070

Open
jottakka wants to merge 1 commit into
mainfrom
split/verify-toolkit-docs-publish-workflow
Open

Verify toolkit docs before publishing#1070
jottakka wants to merge 1 commit into
mainfrom
split/verify-toolkit-docs-publish-workflow

Conversation

@jottakka

@jottakka jottakka commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • run the generator's isolated type-check and test suite before publishing
  • support an explicitly named branch for manual verification PRs
  • avoid assigning normal production reviewers to those verification PRs

Test plan

  • pnpm run toolkit-docs:check

Note

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 for toolkit-docs-generator) instead of building the generator, so broken generator code fails before doc generation and PR creation.

Root package.json adds toolkit-docs:typecheck, toolkit-docs:test, and toolkit-docs:check so 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-requesting ArcadeAI/engineering-tools-and-dx reviewers. Scheduled/Porter runs keep the automation/toolkit-docs branch 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.

@vercel

vercel Bot commented Jul 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 16, 2026 8:20pm

Request Review

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using high effort and found 2 potential issues.

Fix All in Cursor

❌ 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.

Comment thread package.json
"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",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Fix in Cursor Fix in Web

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 15bf213. Configure here.

@jottakka
jottakka marked this pull request as draft July 16, 2026 18:22
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>
@jottakka
jottakka force-pushed the split/verify-toolkit-docs-publish-workflow branch from 15bf213 to 721b9bc Compare July 16, 2026 20:18
@jottakka jottakka self-assigned this Jul 16, 2026
@jottakka
jottakka marked this pull request as ready for review July 16, 2026 21:46
@cursor

cursor Bot commented Jul 16, 2026

Copy link
Copy Markdown

Current version of PR was reviewed by /review-bugbot on Jul 16, 16:06 GMT-3. It flagged 1 finding.

Show 1 finding

1. workflow_dispatch inputs wrongly indented

.github/workflows/generate-toolkit-docs.yml:13 · High Severity

The new inputs block is indented at the same level as workflow_dispatch under on:, so it is a sibling trigger key rather than a child of workflow_dispatch. GitHub Actions only accepts inputs nested under on.workflow_dispatch; a top-level on.inputs entry is treated as an invalid webhook event and the workflow file fails validation.

Bugbot on commit 721b9bc is skipped.

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.

1 participant