@trigger.dev/sdk 4.7.2 → 4.7.4

package/docs/self-hosting/overview.mdx

@@ -100,6 +100,32 @@ All fields are optional. Partial overrides are supported:
 }
 ```
 
+## Custom base images
+
+Deploys build on the published `triggerdotdev/node` and `triggerdotdev/bun` Debian images. To require a different base for every deploy to your instance, such as a FIPS-validated or hardened Node image, set `DEPLOY_BASE_IMAGES` on the webapp (and optionally `DEPLOY_BUILD_BASE_IMAGES` for the build stage):
+
+```bash
+DEPLOY_BASE_IMAGES="node-26=registry.example.com/node-fips:26@sha256:<64-character-digest>"
+```
+
+Entries are comma-separated `runtime=image@sha256:<digest>`. The runtimes are `node-22`, `node-24`, `node-26` and `bun`, and every image must be pinned by digest. An invalid value prevents the webapp from starting. Projects with `runtime: "node"` in their config resolve to the current default Node runtime (`node-24` today), so set that key for them. With the Helm chart, set the variables through `webapp.extraEnvVars`.
+
+Runtimes with an entry build on that image; the others keep the published images. Deploys from CLI versions that cannot apply the images are rejected with an error asking to upgrade, and so are `--native-build`, `--local-bundle` and `--from-bundle` deploys. This is a self-hosting setting and does not apply to Trigger.dev Cloud.
+
+You own a custom base image. It must provide:
+
+- `node` on `PATH` at the runtime's major version (for `bun`, both `bun` and `node`, because the final stage starts the app with `dumb-init node`)
+- `busybox`, `ca-certificates`, `dumb-init`, `git` and `openssl`
+- a `node` user (a `bun` user for the Bun runtime)
+- glibc, so native modules built in the build stage load at runtime
+
+A `DEPLOY_BUILD_BASE_IMAGES` image needs everything the base image provides, plus `python3`, `make` and `g++`. Build extensions that add image instructions are replayed on it. Without an entry, the build stage uses the published build image, except for projects whose build extensions add image instructions: those build from your base image and install the toolchain with `apt-get`, so that base must be Debian-based. To avoid the published images entirely, set both variables.
+
+<Warning>
+  `image.pkgs` and build extensions that run `apt-get` (such as `aptGet` and `playwright`) assume a
+  Debian base. On other distributions, install those packages in your base image instead.
+</Warning>
+
 ## Community support
 
 It's dangerous to go alone! Join the self-hosting channel on our [Discord server](https://discord.gg/NQTxt5NA7s).

package/docs/tags.mdx

@@ -118,3 +118,9 @@ for await (const run of runs.list({ tag: "user_123456", status: ["COMPLETED"] })
   console.log(run.id, run.taskIdentifier, run.finishedAt, run.tags);
 }
 ```
+
+<Tip>
+  To follow runs with a tag as they change, use
+  [`runs.subscribeToRunsWithTag()`](/realtime/backend/subscribe) instead of polling `runs.list()`.
+  See [runs.list() best practices](/runs/list-best-practices).
+</Tip>

package/docs/tasks/scheduled.mdx

@@ -45,7 +45,7 @@ export const firstScheduledTask = schedules.task({
     //this can be undefined if you didn't provide one
     console.log(payload.externalId); //is a string or undefined
 
-    //the next 5 dates this task is scheduled to run
+    //the next 10 dates this task is scheduled to run
     console.log(payload.upcoming); //is an array of Date objects
   },
 });
@@ -58,14 +58,14 @@ You can see from the comments that the payload has several useful properties:
 - `timezone` - the timezone the schedule was registered with, defaults to "UTC". In IANA format, e.g. "America/New_York".
 - `scheduleId` - the id of the schedule that triggered the task
 - `externalId` - the external id you (optionally) provided when creating the schedule
-- `upcoming` - the next 5 times the task is scheduled to run
+- `upcoming` - the next 10 times the task is scheduled to run
 
 <Note>
   This task will NOT get triggered on a schedule until you attach a schedule to it. Read on for how
   to do that.
 </Note>
 
-Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/config/config-file), and you [can configure them](/tasks/overview#defining-a-task).
+Like all tasks they have a [maxDuration](/runs/max-duration), they should be placed inside a [/trigger folder](/config/config-file), and you [can configure them](/tasks/overview#defining-a-task).
 
 You can set a [TTL](/runs#time-to-live-ttl) on a scheduled task to automatically expire runs that aren't dequeued in time. This is useful when a schedule fires while the previous run is still executing - rather than queueing up stale runs, they'll expire:
 
@@ -142,7 +142,7 @@ To use imperative schedules you need to do two things:
 
 ## Spreading runs with windows
 
-By default a schedule runs at its exact cron time. When many schedules share the same cron pattern, such as a daily `0 9 * * *`, they all fire at the same time and load your downstream systems as well as ours. A **window** spreads those runs out: each schedule is assigned a stable time within the window after its cron time, so the load is smoothed while each schedule keeps firing at a predictable, repeatable moment.
+When many schedules share the same cron pattern, such as a daily `0 9 * * *`, they all fire at the same time and load your downstream systems as well as ours. A **window** spreads those runs out: each schedule is assigned a stable time within the window after its cron time, so the load is smoothed while each schedule keeps firing at a predictable, repeatable moment. New schedules use a [60-minute window by default](#default-window).
 
 The assigned time is deterministic. A given schedule always lands at the same offset for a given interval, so runs don't jump around between occurrences. And you can always see exactly when the next run will start.
 
@@ -151,7 +151,7 @@ Set a `window` as either:
 - **An absolute duration** in whole minutes or hours, up to 24 hours: `"30m"`, `"2h"`, `"24h"`. Absolute windows are capped at the next cron time, so a run is never delayed past its following occurrence.
 - **A percentage** of the interval between runs: `"30%"`, `"100%"`. A `"50%"` window on an hourly schedule spreads runs across the first 30 minutes of each hour.
 
-Set `"0m"` (or `"0%"`) for no spreading — the run fires at its exact cron time.
+Set `"0m"` (or `"0%"`) for no spreading — the run fires at its exact cron time. This also overrides the [default window](#default-window).
 
 Declarative schedules set the window on the `cron` object:
 
@@ -184,6 +184,12 @@ const createdSchedule = await schedules.create({
   is the assigned time the run will actually start.
 </Note>
 
+### Default window
+
+New schedules get a default 60-minute window unless you set one, so each run starts at a stable time within the hour after its cron time. Like any absolute window, it's capped at the next cron time: a schedule that runs every 15 minutes is spread across those 15 minutes.
+
+To opt a new schedule out of the default window, set `window: "0m"`.
+
 ### Free-plan minimum window
 
 Schedules created while an organization is on a free plan run no more than once per hour and use a minimum 60-minute window.

package/docs/triggering.mdx

@@ -746,6 +746,12 @@ await myTask.batchTrigger([{ payload: { some: "data" }, options: { delay: "1h" }
   manually, convert Dates to ISO strings first (e.g., `date.toISOString()`).
 </Note>
 
+<Tip>
+  A `delay` doesn't merge triggers: each trigger still creates its own run. To collapse a burst of
+  triggers into one run, use [`debounce`](#debounce). See [runs.list() best
+  practices](/runs/list-best-practices#using-a-fixed-delay-to-space-out-triggers).
+</Tip>
+
 ### `ttl`
 
 You can set a TTL (time to live) when triggering a task, which will automatically expire the run if it hasn't started within the specified time. This is useful for ensuring that a run doesn't get stuck in the queue for too long.
@@ -814,6 +820,8 @@ export const myTask = task({
 });
 ```
 
+Build the key from the work being done, like an order or event ID. A random value on every trigger never matches, so it never dedupes. See [runs.list() best practices](/runs/list-best-practices#using-a-random-idempotency-key).
+
 For more information, see our [Idempotency](/idempotency) documentation.
 
 ### `idempotencyKeyTTL`

package/docs/troubleshooting-alerts.mdx

@@ -243,13 +243,17 @@ This webhook is sent when a run fails. The payload is available on the `object`
 </ParamField>
 
 <ParamField path="object.environment.type" type="string">
-  Environment type (STAGING or PRODUCTION)
+  Environment type (`PRODUCTION`, `STAGING`, or `PREVIEW`)
 </ParamField>
 
 <ParamField path="object.environment.slug" type="string">
   Environment slug
 </ParamField>
 
+<ParamField path="object.environment.branchName" type="string">
+  Environment branch name (optional)
+</ParamField>
+
 <ParamField path="object.organization.id" type="string">
   Organization ID
 </ParamField>
@@ -311,7 +315,7 @@ This webhook is sent when a deployment succeeds. The payload is available on the
 </ParamField>
 
 <ParamField path="object.environment.type" type="string">
-  Environment type (STAGING or PRODUCTION)
+  Environment type (`PRODUCTION`, `STAGING`, or `PREVIEW`)
 </ParamField>
 
 <ParamField path="object.environment.slug" type="string">
@@ -346,6 +350,54 @@ This webhook is sent when a deployment succeeds. The payload is available on the
   Project name
 </ParamField>
 
+<ParamField path="object.git" type="object">
+  Git metadata for the deployment (optional). When present, `branch`, `commitSha`, `commitMessage`, `commitUrl` and `branchUrl` are always set.
+</ParamField>
+
+<ParamField path="object.git.branch" type="string">
+  Git branch
+</ParamField>
+
+<ParamField path="object.git.commitSha" type="string">
+  Short commit SHA (first 7 characters)
+</ParamField>
+
+<ParamField path="object.git.commitMessage" type="string">
+  Commit message (empty string if unavailable)
+</ParamField>
+
+<ParamField path="object.git.commitUrl" type="string">
+  URL of the commit
+</ParamField>
+
+<ParamField path="object.git.branchUrl" type="string">
+  URL of the branch
+</ParamField>
+
+<ParamField path="object.git.pullRequestNumber" type="number">
+  Pull request number (optional)
+</ParamField>
+
+<ParamField path="object.git.pullRequestTitle" type="string">
+  Pull request title (optional)
+</ParamField>
+
+<ParamField path="object.git.pullRequestUrl" type="string">
+  Pull request URL (optional)
+</ParamField>
+
+<ParamField path="object.git.provider" type="string">
+  Git provider (optional)
+</ParamField>
+
+<ParamField path="object.vercel" type="object">
+  Vercel metadata for the deployment (optional)
+</ParamField>
+
+<ParamField path="object.vercel.deploymentUrl" type="string">
+  URL of the deployment in the Vercel dashboard
+</ParamField>
+
 ### Deployment Failed Alert
 
 This webhook is sent when a deployment fails. The payload is available on the `object` property:
@@ -391,7 +443,7 @@ This webhook is sent when a deployment fails. The payload is available on the `o
 </ParamField>
 
 <ParamField path="object.environment.type" type="string">
-  Environment type (STAGING or PRODUCTION)
+  Environment type (`PRODUCTION`, `STAGING`, or `PREVIEW`)
 </ParamField>
 
 <ParamField path="object.environment.slug" type="string">
@@ -426,6 +478,53 @@ This webhook is sent when a deployment fails. The payload is available on the `o
   Project name
 </ParamField>
 
+<ParamField path="object.git" type="object">
+  Git metadata for the deployment (optional). When present, `branch`, `commitSha`, `commitMessage`, `commitUrl` and `branchUrl` are always set.
+</ParamField>
+
+<ParamField path="object.git.branch" type="string">
+  Git branch
+</ParamField>
+
+<ParamField path="object.git.commitSha" type="string">
+  Short commit SHA (first 7 characters)
+</ParamField>
+
+<ParamField path="object.git.commitMessage" type="string">
+  Commit message (empty string if unavailable)
+</ParamField>
+
+<ParamField path="object.git.commitUrl" type="string">
+  URL of the commit
+</ParamField>
+
+<ParamField path="object.git.branchUrl" type="string">
+  URL of the branch
+</ParamField>
+
+<ParamField path="object.git.pullRequestNumber" type="number">
+  Pull request number (optional)
+</ParamField>
+
+<ParamField path="object.git.pullRequestTitle" type="string">
+  Pull request title (optional)
+</ParamField>
+
+<ParamField path="object.git.pullRequestUrl" type="string">
+  Pull request URL (optional)
+</ParamField>
+
+<ParamField path="object.git.provider" type="string">
+  Git provider (optional)
+</ParamField>
+
+<ParamField path="object.vercel" type="object">
+  Vercel metadata for the deployment (optional)
+</ParamField>
+
+<ParamField path="object.vercel.deploymentUrl" type="string">
+  URL of the deployment in the Vercel dashboard
+</ParamField>
 
 ### Error Group Alert
 

package/docs/troubleshooting.mdx

@@ -251,7 +251,7 @@ If runs are staying in the `QUEUED` state for extended periods, check your concu
 **Solutions:**
 
 - **Increase concurrency limits** - If you're on a paid plan, increase your environment concurrency limit via the dashboard
-- **Review queue concurrency limits** - Check if individual queues have restrictive `concurrencyLimit` settings
+- **Review concurrency settings** - Check if your tasks have restrictive `concurrency` settings, or your queues a restrictive legacy `concurrencyLimit`. See [Concurrency](/concurrency)
 - **Check for stuck runs** - See if stalled runs are blocking new executions
 
 ### Runs queued because a billing limit was reached

package/docs/upgrading-packages.mdx

@@ -39,12 +39,12 @@ You can deploy using [GitHub Actions](/github-actions). We recommend that you lo
 
 <Steps>
   <Step title="Find your workflow file">
-    In your `.githubs/workflows` folder you can find your workflow yml files. You may have a prod
+    In your `.github/workflows` folder you can find your workflow yml files. You may have a prod
     and staging one.
   </Step>
   <Step title="Update the version for the run command">
     In the steps you'll see a `run` command. It will run the trigger.dev deploy CLI command. Make
-    sure to update this version to the latest version (e.g. `npx trigger.dev@3.0.0 deploy`).
+    sure to update this version to the latest version (e.g. `npx trigger.dev@4.7.3 deploy`).
   </Step>
 </Steps>
 
@@ -57,7 +57,7 @@ For example:
 ```json
 {
   "devDependencies": {
-    "trigger.dev": "3.0.0"
+    "trigger.dev": "4.7.3"
   }
 }
 ```

package/docs/vercel-integration.mdx

@@ -129,7 +129,17 @@ The integration sets this up for you:
 - It passes your commit SHA as the deployment's external id.
 - `VERCEL_GIT_COMMIT_SHA` is available at runtime on Vercel, so the SDK finds the matching id with no work from you.
 
-There is nothing to enable, and it works in production, staging and preview alike. Nothing is gated: your Vercel deployment is never held back.
+There is nothing to enable, and it works in production, staging and preview alike.
+
+### Production waits for your tasks
+
+A production deployment from a push to the branch Trigger.dev builds for production gets a blocking **Trigger.dev Build** check. Vercel holds the deployment until the task build for the same commit finishes, then assigns your production domains as usual. If the task build fails or is canceled, the check fails and the Vercel deployment doesn't go live, so your app never ships against tasks that didn't build.
+
+If no task build for the commit has started within 10 minutes, the check fails too.
+
+To retry after a failed build, re-run the **Trigger.dev deployment** check on the commit in GitHub. Once that build succeeds, redeploy from Vercel or push a new commit.
+
+A production deployment with no task build to wait for is never held: its check is marked skipped. That covers deployments from the Vercel CLI, from a branch that isn't your production branch in Trigger.dev, and from projects without a connected GitHub repository. Preview and staging deployments aren't held either: their check passes straight away, and version skew protection makes their runs wait for the matching task build instead.
 
 <Note>
   Version skew protection requires the `@trigger.dev/sdk` release that introduces external
@@ -146,8 +156,8 @@ To opt out, set `TRIGGER_AUTOMATIC_SKEW_VERSION_PROTECTION` to `0` on your Verce
 <Warning>
   **Automatic atomic deployments are deprecated.** Use [version skew
   protection](/deployment/atomic-deployment) instead — it needs no second Vercel deployment,
-  never gates your app's deploy, doesn't touch `Auto-assign Custom Production Domains`, and covers
-  staging and preview as well as production.
+  doesn't touch `Auto-assign Custom Production Domains`, and covers staging and preview as well as
+  production. Production deployments still wait for your task build through the blocking check.
 
   Nothing is being switched off. The setting stays in your project's Vercel settings, keeps working,
   and remains the way to hold your Vercel deployment back until your tasks have built. New

package/docs/versioning.mdx

@@ -51,7 +51,7 @@ Because your application and your tasks deploy separately, a release of your app
 
 ## Retries and reattempts
 
-When a task has an uncaught error it will [retry](/errors-retrying), assuming you have not set `maxAttempts` to 0. Retries are locked to the original version of the run.
+When a task has an uncaught error it will [retry](/errors-retrying), if the task has retries configured (the `retry` option or `retries.default` in your config). Retries are locked to the original version of the run.
 
 ## Replays
 

package/docs/wait-for-token.mdx

@@ -135,7 +135,7 @@ Create a waitpoint token.
 The `createToken` function accepts an object with the following properties:
 
 <ParamField query="timeout" type="string" optional>
-  The maximum amount of time to wait for the token to be completed. Defaults to "10m".
+  The maximum amount of time to wait for the token to be completed. If omitted, the token has no timeout. Accepts a duration string like `"30s"` or `"4w"`, or a `Date`.
 </ParamField>
 
 <ParamField query="idempotencyKey" type="string" optional>
@@ -144,7 +144,7 @@ The `createToken` function accepts an object with the following properties:
 </ParamField>
 
 <ParamField query="idempotencyKeyTTL" type="string" optional>
-  The time to live for the idempotency key. Defaults to "1h".
+  The time to live for the idempotency key. If omitted, the key does not expire.
 </ParamField>
 
 <ParamField query="tags" type="string[]" optional>
@@ -380,7 +380,7 @@ The `listTokens` function accepts an object with the following properties:
 </ParamField>
 
 <ParamField query="period" type="string" optional>
-  The period to filter by. Can be one of: `1h`, `1d`, `7d`, `30d`.
+  The period to filter by, as a duration string such as `1h`, `1d`, `7d` or `30d`.
 </ParamField>
 
 <ParamField query="from" type="Date | number" optional>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trigger.dev/sdk",
-  "version": "4.7.2",
+  "version": "4.7.4",
   "description": "trigger.dev Node.JS SDK",
   "license": "MIT",
   "publishConfig": {
@@ -69,7 +69,7 @@
   "dependencies": {
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/semantic-conventions": "1.41.1",
-    "@trigger.dev/core": "4.7.2",
+    "@trigger.dev/core": "4.7.4",
     "uncrypto": "^0.1.3"
   },
   "devDependencies": {