Skip to content

Docs – v4 GA updates #2298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 42 commits into from
Aug 18, 2025
Merged

Docs – v4 GA updates #2298

merged 42 commits into from
Aug 18, 2025

Conversation

samejr
Copy link
Member

@samejr samejr commented Jul 23, 2025

Todos

  • Update existing references page
  • Add waitpoint references
  • Add queue references
  • Update CLI references
  • Node 22 support and Bun
  • Update bulk actions page
  • Update test page

Copy link

changeset-bot bot commented Jul 23, 2025

⚠️ No Changeset found

Latest commit: 0d1608c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jul 23, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This PR updates extensive documentation. Most code samples switch imports from @trigger.dev/sdk/v3 to @trigger.dev/sdk and remove v4-beta notes/tags, updating CLI examples to @latest/stable versions. Navigation and redirects are revised in docs/docs.json. New docs are added for hidden tasks, run priority, and the useWaitToken React hook. Several guides are restructured (bulk actions, run tests), and limits/rate-limit guidance is updated. Self-hosting (Docker/Kubernetes) docs are expanded and modernized. Run lifecycle docs are overhauled (state names, dequeued/canceled), queue concurrency behavior is clarified, boolean helper snippets are added, and multiple guides/examples reflect the new import path.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~75 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e864973 and 0d1608c.

⛔ Files ignored due to path filters (9)
  • docs/images/bulk-action-create.png is excluded by !**/*.png
  • docs/images/bulk-action-open-panel.png is excluded by !**/*.png
  • docs/images/bulk-action-page.png is excluded by !**/*.png
  • docs/images/priority-runs.png is excluded by !**/*.png
  • docs/images/test-dashboard.png is excluded by !**/*.png
  • docs/images/test-page.png is excluded by !**/*.png
  • docs/images/test-select-environment.png is excluded by !**/*.png
  • docs/images/test-select-task.png is excluded by !**/*.png
  • docs/images/test-set-payload.png is excluded by !**/*.png
📒 Files selected for processing (107)
  • docs/apikeys.mdx (1 hunks)
  • docs/bulk-actions.mdx (2 hunks)
  • docs/cli-preview-archive.mdx (2 hunks)
  • docs/cli-switch.mdx (2 hunks)
  • docs/config/config-file.mdx (16 hunks)
  • docs/config/extensions/additionalFiles.mdx (1 hunks)
  • docs/config/extensions/additionalPackages.mdx (2 hunks)
  • docs/config/extensions/aptGet.mdx (2 hunks)
  • docs/config/extensions/audioWaveform.mdx (1 hunks)
  • docs/config/extensions/custom.mdx (7 hunks)
  • docs/config/extensions/emitDecoratorMetadata.mdx (1 hunks)
  • docs/config/extensions/esbuildPlugin.mdx (1 hunks)
  • docs/config/extensions/ffmpeg.mdx (2 hunks)
  • docs/config/extensions/overview.mdx (2 hunks)
  • docs/config/extensions/playwright.mdx (3 hunks)
  • docs/config/extensions/prismaExtension.mdx (4 hunks)
  • docs/config/extensions/puppeteer.mdx (1 hunks)
  • docs/config/extensions/pythonExtension.mdx (8 hunks)
  • docs/config/extensions/syncEnvVars.mdx (4 hunks)
  • docs/context.mdx (1 hunks)
  • docs/deploy-environment-variables.mdx (1 hunks)
  • docs/deployment/overview.mdx (1 hunks)
  • docs/deployment/preview-branches.mdx (2 hunks)
  • docs/docs.json (14 hunks)
  • docs/errors-retrying.mdx (6 hunks)
  • docs/guides/ai-agents/generate-translate-copy.mdx (1 hunks)
  • docs/guides/ai-agents/respond-and-check-content.mdx (1 hunks)
  • docs/guides/ai-agents/route-question.mdx (1 hunks)
  • docs/guides/ai-agents/translate-and-refine.mdx (1 hunks)
  • docs/guides/ai-agents/verify-news-article.mdx (1 hunks)
  • docs/guides/example-projects/human-in-the-loop-workflow.mdx (0 hunks)
  • docs/guides/example-projects/mastra-agents-with-memory.mdx (0 hunks)
  • docs/guides/example-projects/meme-generator-human-in-the-loop.mdx (0 hunks)
  • docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx (0 hunks)
  • docs/guides/example-projects/vercel-ai-sdk-deep-research.mdx (0 hunks)
  • docs/guides/examples/dall-e3-generate-image.mdx (1 hunks)
  • docs/guides/examples/deepgram-transcribe-audio.mdx (1 hunks)
  • docs/guides/examples/fal-ai-image-to-cartoon.mdx (1 hunks)
  • docs/guides/examples/fal-ai-realtime.mdx (1 hunks)
  • docs/guides/examples/ffmpeg-video-processing.mdx (4 hunks)
  • docs/guides/examples/firecrawl-url-crawl.mdx (2 hunks)
  • docs/guides/examples/libreoffice-pdf-conversion.mdx (2 hunks)
  • docs/guides/examples/open-ai-with-retrying.mdx (1 hunks)
  • docs/guides/examples/pdf-to-image.mdx (1 hunks)
  • docs/guides/examples/puppeteer.mdx (4 hunks)
  • docs/guides/examples/react-email.mdx (2 hunks)
  • docs/guides/examples/react-pdf.mdx (1 hunks)
  • docs/guides/examples/satori.mdx (1 hunks)
  • docs/guides/examples/scrape-hacker-news.mdx (2 hunks)
  • docs/guides/examples/sentry-error-tracking.mdx (2 hunks)
  • docs/guides/examples/sharp-image-processing.mdx (2 hunks)
  • docs/guides/examples/stripe-webhook.mdx (3 hunks)
  • docs/guides/examples/supabase-database-operations.mdx (2 hunks)
  • docs/guides/examples/supabase-storage-upload.mdx (2 hunks)
  • docs/guides/examples/vercel-ai-sdk.mdx (1 hunks)
  • docs/guides/examples/vercel-sync-env-vars.mdx (1 hunks)
  • docs/guides/frameworks/bun.mdx (1 hunks)
  • docs/guides/frameworks/drizzle.mdx (2 hunks)
  • docs/guides/frameworks/nextjs-webhooks.mdx (2 hunks)
  • docs/guides/frameworks/nextjs.mdx (5 hunks)
  • docs/guides/frameworks/prisma.mdx (2 hunks)
  • docs/guides/frameworks/remix-webhooks.mdx (1 hunks)
  • docs/guides/frameworks/remix.mdx (3 hunks)
  • docs/guides/frameworks/sequin.mdx (2 hunks)
  • docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx (2 hunks)
  • docs/guides/new-build-system-preview.mdx (11 hunks)
  • docs/guides/python/python-crawl4ai.mdx (2 hunks)
  • docs/guides/python/python-doc-to-markdown.mdx (2 hunks)
  • docs/guides/python/python-image-processing.mdx (2 hunks)
  • docs/guides/python/python-pdf-form-extractor.mdx (2 hunks)
  • docs/guides/use-cases/upgrading-from-v2.mdx (3 hunks)
  • docs/hidden-tasks.mdx (1 hunks)
  • docs/how-it-works.mdx (6 hunks)
  • docs/idempotency.mdx (6 hunks)
  • docs/limits.mdx (3 hunks)
  • docs/logging.mdx (2 hunks)
  • docs/machines.mdx (4 hunks)
  • docs/management/advanced-usage.mdx (1 hunks)
  • docs/management/authentication.mdx (3 hunks)
  • docs/management/auto-pagination.mdx (2 hunks)
  • docs/management/errors-and-retries.mdx (3 hunks)
  • docs/management/overview.mdx (1 hunks)
  • docs/manual-setup.mdx (10 hunks)
  • docs/migrating-from-v3.mdx (1 hunks)
  • docs/migration-defer.mdx (2 hunks)
  • docs/migration-mergent.mdx (2 hunks)
  • docs/open-source-self-hosting.mdx (1 hunks)
  • docs/queue-concurrency.mdx (9 hunks)
  • docs/realtime/react-hooks/use-wait-token.mdx (1 hunks)
  • docs/run-tests.mdx (1 hunks)
  • docs/run-usage.mdx (1 hunks)
  • docs/runs.mdx (14 hunks)
  • docs/runs/max-duration.mdx (6 hunks)
  • docs/runs/metadata.mdx (22 hunks)
  • docs/runs/priority.mdx (1 hunks)
  • docs/self-hosting/docker.mdx (7 hunks)
  • docs/self-hosting/kubernetes.mdx (21 hunks)
  • docs/snippets/bundle-packages.mdx (2 hunks)
  • docs/snippets/code/openai-retry.mdx (1 hunks)
  • docs/snippets/migrate-v4-using-ai.mdx (1 hunks)
  • docs/snippets/node-versions.mdx (1 hunks)
  • docs/snippets/rate-limit-hit-use-batchtrigger.mdx (1 hunks)
  • docs/snippets/run-boolean-helpers.mdx (1 hunks)
  • docs/snippets/step-run-test.mdx (1 hunks)
  • docs/snippets/upgrade-to-v4-note.mdx (0 hunks)
  • docs/tags.mdx (2 hunks)
  • docs/tasks/overview.mdx (9 hunks)
⛔ Files not processed due to max files limit (11)
  • docs/tasks/scheduled.mdx
  • docs/tasks/schemaTask.mdx
  • docs/triggering.mdx
  • docs/troubleshooting-alerts.mdx
  • docs/troubleshooting.mdx
  • docs/upgrade-to-v4.mdx
  • docs/upgrading-beta.mdx
  • docs/wait-for-token.mdx
  • docs/wait-for.mdx
  • docs/wait-until.mdx
  • docs/writing-tasks-introduction.mdx
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/v4-docs-updates

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

# Conflicts:
#	docs/docs.json
#	docs/frontend/overview.mdx
#	docs/frontend/react-hooks/overview.mdx
#	docs/guides/example-projects/human-in-the-loop-workflow.mdx
#	docs/management/authentication.mdx
#	docs/realtime/backend/streams.mdx
#	docs/realtime/overview.mdx
#	docs/realtime/react-hooks/triggering.mdx
#	docs/realtime/react-hooks/use-wait-token.mdx
#	docs/realtime/subscribe-to-batch.mdx
#	docs/realtime/subscribe-to-run.mdx
#	docs/realtime/subscribe-to-runs-with-tag.mdx
#	docs/triggering.mdx
#	docs/upgrade-to-v4.mdx
@matt-aitken matt-aitken marked this pull request as ready for review August 18, 2025 11:34
@matt-aitken matt-aitken merged commit fade220 into main Aug 18, 2025
5 of 6 checks passed
@matt-aitken matt-aitken deleted the docs/v4-docs-updates branch August 18, 2025 11:34
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.

3 participants