From fade22015fe6a801193c97da12cc0d714bd97523 Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Mon, 18 Aug 2025 12:34:55 +0100 Subject: [PATCH] =?UTF-8?q?Docs=20=E2=80=93=20v4=20GA=20updates=20(#2298)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com> --- docs/apikeys.mdx | 2 +- docs/bulk-actions.mdx | 41 ++- docs/cli-preview-archive.mdx | 12 +- docs/cli-switch.mdx | 12 +- docs/config/config-file.mdx | 37 +-- docs/config/extensions/additionalFiles.mdx | 2 +- docs/config/extensions/additionalPackages.mdx | 4 +- docs/config/extensions/aptGet.mdx | 4 +- docs/config/extensions/audioWaveform.mdx | 2 +- docs/config/extensions/custom.mdx | 14 +- .../extensions/emitDecoratorMetadata.mdx | 2 +- docs/config/extensions/esbuildPlugin.mdx | 2 +- docs/config/extensions/ffmpeg.mdx | 4 +- docs/config/extensions/overview.mdx | 4 +- docs/config/extensions/playwright.mdx | 11 +- docs/config/extensions/prismaExtension.mdx | 8 +- docs/config/extensions/puppeteer.mdx | 2 +- docs/config/extensions/pythonExtension.mdx | 16 +- docs/config/extensions/syncEnvVars.mdx | 8 +- docs/context.mdx | 2 +- docs/deploy-environment-variables.mdx | 2 +- docs/deployment/overview.mdx | 2 +- docs/deployment/preview-branches.mdx | 13 +- docs/docs.json | 97 ++---- docs/errors-retrying.mdx | 12 +- .../ai-agents/generate-translate-copy.mdx | 2 +- .../ai-agents/respond-and-check-content.mdx | 2 +- docs/guides/ai-agents/route-question.mdx | 2 +- .../guides/ai-agents/translate-and-refine.mdx | 2 +- docs/guides/ai-agents/verify-news-article.mdx | 2 +- .../human-in-the-loop-workflow.mdx | 5 - .../mastra-agents-with-memory.mdx | 5 - .../meme-generator-human-in-the-loop.mdx | 5 - ...penai-agents-sdk-typescript-playground.mdx | 1 - .../vercel-ai-sdk-deep-research.mdx | 5 - .../examples/dall-e3-generate-image.mdx | 2 +- .../examples/deepgram-transcribe-audio.mdx | 2 +- .../examples/fal-ai-image-to-cartoon.mdx | 2 +- docs/guides/examples/fal-ai-realtime.mdx | 2 +- .../examples/ffmpeg-video-processing.mdx | 8 +- docs/guides/examples/firecrawl-url-crawl.mdx | 4 +- .../examples/libreoffice-pdf-conversion.mdx | 4 +- .../guides/examples/open-ai-with-retrying.mdx | 2 +- docs/guides/examples/pdf-to-image.mdx | 2 +- docs/guides/examples/puppeteer.mdx | 8 +- docs/guides/examples/react-email.mdx | 4 +- docs/guides/examples/react-pdf.mdx | 2 +- docs/guides/examples/satori.mdx | 2 +- docs/guides/examples/scrape-hacker-news.mdx | 4 +- .../guides/examples/sentry-error-tracking.mdx | 4 +- .../examples/sharp-image-processing.mdx | 4 +- docs/guides/examples/stripe-webhook.mdx | 6 +- .../examples/supabase-database-operations.mdx | 4 +- .../examples/supabase-storage-upload.mdx | 4 +- docs/guides/examples/vercel-ai-sdk.mdx | 2 +- docs/guides/examples/vercel-sync-env-vars.mdx | 2 +- docs/guides/frameworks/bun.mdx | 2 +- docs/guides/frameworks/drizzle.mdx | 4 +- docs/guides/frameworks/nextjs-webhooks.mdx | 4 +- docs/guides/frameworks/nextjs.mdx | 10 +- docs/guides/frameworks/prisma.mdx | 4 +- docs/guides/frameworks/remix-webhooks.mdx | 2 +- docs/guides/frameworks/remix.mdx | 6 +- docs/guides/frameworks/sequin.mdx | 4 +- ...abase-edge-functions-database-webhooks.mdx | 4 +- docs/guides/new-build-system-preview.mdx | 24 +- docs/guides/python/python-crawl4ai.mdx | 4 +- docs/guides/python/python-doc-to-markdown.mdx | 9 +- .../guides/python/python-image-processing.mdx | 4 +- .../python/python-pdf-form-extractor.mdx | 4 +- docs/guides/use-cases/upgrading-from-v2.mdx | 6 +- docs/hidden-tasks.mdx | 56 ++++ docs/how-it-works.mdx | 12 +- docs/idempotency.mdx | 12 +- docs/images/bulk-action-create.png | Bin 0 -> 572513 bytes docs/images/bulk-action-open-panel.png | Bin 0 -> 91135 bytes docs/images/bulk-action-page.png | Bin 0 -> 346495 bytes docs/images/priority-runs.png | Bin 0 -> 71950 bytes docs/images/test-dashboard.png | Bin 0 -> 365098 bytes docs/images/test-page.png | Bin 298148 -> 0 bytes docs/images/test-select-environment.png | Bin 47136 -> 0 bytes docs/images/test-select-task.png | Bin 140741 -> 0 bytes docs/images/test-set-payload.png | Bin 175072 -> 0 bytes docs/limits.mdx | 6 +- docs/logging.mdx | 4 +- docs/machines.mdx | 10 +- docs/management/advanced-usage.mdx | 2 +- docs/management/authentication.mdx | 67 +++- docs/management/auto-pagination.mdx | 4 +- docs/management/errors-and-retries.mdx | 6 +- docs/management/overview.mdx | 4 +- docs/manual-setup.mdx | 54 ++-- docs/migrating-from-v3.mdx | 305 ++++++++++++++++++ docs/migration-defer.mdx | 4 +- docs/migration-mergent.mdx | 4 +- docs/open-source-self-hosting.mdx | 6 +- docs/queue-concurrency.mdx | 58 ++-- docs/realtime/react-hooks/use-wait-token.mdx | 34 ++ docs/run-tests.mdx | 22 +- docs/run-usage.mdx | 4 +- docs/runs.mdx | 80 +++-- docs/runs/max-duration.mdx | 12 +- docs/runs/metadata.mdx | 44 +-- docs/runs/priority.mdx | 31 ++ docs/self-hosting/docker.mdx | 49 +-- docs/self-hosting/kubernetes.mdx | 52 +-- docs/snippets/bundle-packages.mdx | 4 +- docs/snippets/code/openai-retry.mdx | 2 +- docs/snippets/migrate-v4-using-ai.mdx | 212 ++++++++++++ docs/snippets/node-versions.mdx | 23 +- .../rate-limit-hit-use-batchtrigger.mdx | 2 +- docs/snippets/run-boolean-helpers.mdx | 7 + docs/snippets/step-run-test.mdx | 10 +- docs/snippets/upgrade-to-v4-note.mdx | 4 - docs/tags.mdx | 4 +- docs/tasks/overview.mdx | 260 ++++++++++++++- docs/tasks/scheduled.mdx | 4 +- docs/tasks/schemaTask.mdx | 156 ++++++++- docs/triggering.mdx | 46 +-- docs/troubleshooting-alerts.mdx | 2 +- docs/troubleshooting.mdx | 4 +- docs/upgrade-to-v4.mdx | 16 +- docs/upgrading-beta.mdx | 24 +- docs/wait-for-token.mdx | 17 +- docs/wait-for.mdx | 9 + docs/wait-until.mdx | 13 + docs/writing-tasks-introduction.mdx | 2 + 127 files changed, 1668 insertions(+), 606 deletions(-) create mode 100644 docs/hidden-tasks.mdx create mode 100644 docs/images/bulk-action-create.png create mode 100644 docs/images/bulk-action-open-panel.png create mode 100644 docs/images/bulk-action-page.png create mode 100644 docs/images/priority-runs.png create mode 100644 docs/images/test-dashboard.png delete mode 100644 docs/images/test-page.png delete mode 100644 docs/images/test-select-environment.png delete mode 100644 docs/images/test-select-task.png delete mode 100644 docs/images/test-set-payload.png create mode 100644 docs/migrating-from-v3.mdx create mode 100644 docs/realtime/react-hooks/use-wait-token.mdx create mode 100644 docs/runs/priority.mdx create mode 100644 docs/snippets/migrate-v4-using-ai.mdx create mode 100644 docs/snippets/run-boolean-helpers.mdx delete mode 100644 docs/snippets/upgrade-to-v4-note.mdx diff --git a/docs/apikeys.mdx b/docs/apikeys.mdx index 5b9eeef1a..38626760e 100644 --- a/docs/apikeys.mdx +++ b/docs/apikeys.mdx @@ -39,7 +39,7 @@ The default URL is `https://api.trigger.dev`. If you prefer to manually configure the SDK, you can call the `configure` method: ```ts -import { configure } from "@trigger.dev/sdk/v3"; +import { configure } from "@trigger.dev/sdk"; import { myTask } from "./trigger/myTasks"; configure({ diff --git a/docs/bulk-actions.mdx b/docs/bulk-actions.mdx index 0e2b4468a..04d0551c9 100644 --- a/docs/bulk-actions.mdx +++ b/docs/bulk-actions.mdx @@ -3,16 +3,10 @@ title: "Bulk actions" description: "Perform actions like replay and cancel on multiple runs at once." --- -Bulk actions allow you to perform operations like replaying or canceling on multiple runs at once. This is especially useful when you need to retry a batch of failed runs with a new version of your code, or when you need to cancel multiple in-progress runs. - -## Bulk replaying - -You can replay multiple runs at once by selecting them from the table on the Runs page using the checkbox on the left hand side of the row. Then click the "Replay runs" button from the bulk action bar that appears at the bottom of the screen. - -This is especially useful if you have lots of failed runs and want to run them all again. To do this, first filter the runs by the status you want, then select all the runs you want to replay and click the "Replay runs" button from the bulk action bar at the bottom of the page. +Bulk actions allow you to perform replaying and canceling on multiple runs at once. This is especially useful when you need to retry a batch of failed runs with a new version of your code, or when you need to cancel multiple in-progress runs.