feat(sdk,cli): bundle agent skills + docs in the SDK for zero-drift#3937
Conversation
@trigger.dev/sdk now ships the agent skills and a curated snapshot of the docs the skills cite. The skills the CLI installs into your coding agent (.claude/skills and friends) are thin pointers that read this content directly from node_modules, so the guidance always matches the SDK version in your project instead of going stale until the next reinstall.
🦋 Changeset detectedLatest commit: 99e736f The changes in this PR will be included in the next version bump. This PR includes changesets to release 25 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughThis PR adds a bundling pipeline (scripts/bundleSdkDocs.ts) that extracts docs referenced by SKILL.md frontmatter and copies them into packages/trigger-sdk/docs. package.json and build scripts are updated to run and publish the bundled docs and skills; .gitignore and a changeset are updated accordingly. CLI skill SKILL.md files are replaced with pointers to the installed 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install timed out. The project may have too many dependencies for the sandbox. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
The bundled skills now reference the docs shipped alongside them in @trigger.dev/sdk (read from node_modules, pinned to your installed version) instead of the docs website, and the CLI pointer skills name the bundled doc set and its sources explicitly. An assistant reading a skill is sent to the local pinned copy.
@trigger.dev/build
trigger.dev
@trigger.dev/core
@trigger.dev/python
@trigger.dev/react-hooks
@trigger.dev/redis-worker
@trigger.dev/rsc
@trigger.dev/schema-to-json
@trigger.dev/sdk
commit: |
…undle The realtime skill's TriggerButton example named its token `publicAccessToken` while passing it to useTaskTrigger, which contradicts the skill's own warning that a read token cannot trigger a task. Renamed to `triggerToken`. bundleSdkDocs now throws instead of warning when no doc sources are found, so a broken skills dir fails the build rather than shipping the SDK with missing docs.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
packages/trigger-sdk/skills/realtime-and-frontend/SKILL.md (1)
258-260:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix the handle subscription example to pass
handle.id.The "correct" code snippet only adds the
enabledguard but still passeshandle(the object) as the first argument. The hook needs arunIdstring, so it should behandle.id.Suggested fix
-const { run } = useRealtimeRun(handle, { accessToken: handle?.publicAccessToken, enabled: !!handle }); +const { run } = useRealtimeRun(handle.id, { accessToken: handle.publicAccessToken, enabled: !!handle });
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 3ff464b7-99ec-40ac-81cf-de3497fe125c
📒 Files selected for processing (2)
packages/trigger-sdk/skills/realtime-and-frontend/SKILL.mdscripts/bundleSdkDocs.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- scripts/bundleSdkDocs.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (37)
- GitHub Check: internal / 🧪 Unit Tests: Internal (10, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (8, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (12, 12)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: internal / 🧪 Unit Tests: Internal (6, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (10, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (2, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (7, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (9, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (2, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (5, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (1, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (8, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (9, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (11, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (3, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (1, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (7, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (6, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (3, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (4, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (5, 10)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (4, 10)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: sdk-compat / Node.js 20.20 (ubuntu-latest)
- GitHub Check: sdk-compat / Node.js 22.12 (ubuntu-latest)
- GitHub Check: e2e-webapp / 🧪 E2E Tests: Webapp
- GitHub Check: sdk-compat / Deno Runtime
- GitHub Check: sdk-compat / Bun Runtime
- GitHub Check: sdk-compat / Cloudflare Workers
- GitHub Check: packages / 🧪 Unit Tests: Packages (1, 3)
- GitHub Check: packages / 🧪 Unit Tests: Packages (3, 3)
- GitHub Check: packages / 🧪 Unit Tests: Packages (2, 3)
- GitHub Check: typecheck / typecheck
- GitHub Check: Build and publish previews
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,ts,tsx,jsx,css,json,md}
📄 CodeRabbit inference engine (AGENTS.md)
Use Prettier for code formatting and run
pnpm run formatbefore committing
Files:
packages/trigger-sdk/skills/realtime-and-frontend/SKILL.md
🪛 SkillSpector (2.1.1)
packages/trigger-sdk/skills/realtime-and-frontend/SKILL.md
[error] 235: [PE3] Credential Access: Code accesses credential files (SSH keys, AWS credentials, etc.). This could indicate credential theft attempts.
Remediation: Remove references to credential paths. Use environment variables or secrets managers. For docs, use placeholder paths (e.g., /path/to/config). Never load .env or token files in production code paths.
(Privilege Escalation (PE3))
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
There was a problem hiding this comment.
Devin Review found 1 potential issue.
🐛 1 issue in files not directly in the diff
🐛 Turbo cache outputs missing docs/**, causing docs to vanish on cache hits (turbo.json:7-13)
The SDK build now generates a docs/ directory via the bundle-docs step, and docs is listed in files[] for npm publishing. However, the global turbo.json build pipeline only caches "dist/**" (plus a few other unrelated globs) as outputs — docs/** is not included. After a clean (which runs rimraf dist docs … at package.json:67) followed by a Turbo cache-hit build, dist/ is restored from cache but docs/ is not, because Turbo never saved it. The published npm package would then ship without the bundled docs that the slimmed-down CLI skills (packages/cli-v3/skills/*/SKILL.md) now redirect AI agents to read from node_modules/@trigger.dev/sdk/docs/….
ericallam
deleted the
feature/tri-10879-ship-docs-skills-in-triggerdevsdk-for-zero-drift-agent
branch
2 participants
Summary
@trigger.dev/sdknow ships the Trigger.dev agent skills and a curated snapshot of the docs those skills cite. The skills thattrigger skillsinstalls into your coding agent are thin pointers that read this bundled content fromnode_modules, so the guidance always matches the SDK version installed in your project. Previously the full skill text was copied into your repo at install time and went stale until you reinstalled after an upgrade.How it works
The SDK's
files[]now includesskills/(the full skill text) anddocs/(a curated snapshot generated at build time). The docs manifest is derived from each skill's ownsources:frontmatter, so a skill only ships the docs it references, and a skill that cites a missing doc fails the build.The CLI installs thin skills whose body points the agent at
node_modules/@trigger.dev/sdk/skills/<name>/SKILL.mdandnode_modules/@trigger.dev/sdk/docs/. They keep the high-value "Common mistakes" anti-patterns inline so the trigger and the guardrails survive even if the agent does not follow the pointer.getting-startedstays self-contained in the CLI because it runs before the SDK is installed.