Skip to content

Updated main README #2432

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 17 commits into from
Aug 21, 2025
Merged

Updated main README #2432

merged 17 commits into from
Aug 21, 2025

Conversation

D-K-P
Copy link
Member

@D-K-P D-K-P commented Aug 21, 2025

No description provided.

Copy link

changeset-bot bot commented Aug 21, 2025

⚠️ No Changeset found

Latest commit: 99b7e5d

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Aug 21, 2025

Walkthrough

The README.md is comprehensively rewritten. It replaces the previous framing with an AI agent–focused narrative and reorganizes sections. A new platform overview is added, highlighting runtime/system packages and human-in-the-loop. The environments list now includes Preview. The code example section is renamed and updated to import from @trigger.dev/sdk instead of @trigger.dev/sdk/v3. Links and assets are refreshed, including trace image and documentation paths. Self-hosting content is expanded with Docker and Kubernetes guides. Support/community references are updated. Overall structure and headings are reworded to align with the new documentation and onboarding flow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 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.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch readme-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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

72-84: Standardize Trigger.dev SDK import paths across repository

We’ve confirmed mixed usage of @trigger.dev/sdk and @trigger.dev/sdk/v3 in our examples, docs, and templates. To avoid confusion and ensure a smooth user experience, please choose one public entrypoint and update all references accordingly:

• README.md (line 72)
• docs/manual-setup.mdx (multiple imports)
• docs/upgrade-to-v4.mdx (numerous examples)
• All packages/cli-v3/templates example files
• apps/webapp/app/v3/services/**/*.{ts,tsx}
• Any other code samples under docs/ or apps/

Example refactor if keeping the versioned path:

- import { task } from "@trigger.dev/sdk";
+ import { task } from "@trigger.dev/sdk/v3";

Or, if the new public entrypoint is unversioned (@trigger.dev/sdk), remove /v3 from all existing imports instead.

Additionally, add a brief “Migrating from v3” section in your docs to guide users through any necessary changes.

🧹 Nitpick comments (7)
packages/cli-v3/README.md (2)

12-12: Tidy badge alt text

Alt text currently reads “License: ” (trailing colon/blank). Consider “License: MIT” (or simply “License”) for cleaner accessibility.

Apply:

-[![License: ](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

25-27: Minor grammar polish

“which handles the horizontal scaling” → “that handles horizontal scaling.”

-...elastic infrastructure which handles the horizontal scaling.
+...elastic infrastructure that handles horizontal scaling.
README.md (3)

42-66: Consistent heading and hyphenation

  • Remove trailing colon in “Key features:” (markdownlint MD026).
  • Standardize “Realtime” → “Real-time” to match later “Real-time alerts.”
-## Key features:
+## Key features
-**[Trigger.dev Realtime](...)** - Trigger, subscribe...
+**[Trigger.dev Real-time](...)** - Trigger, subscribe...

54-56: Environment names: normalize across the doc

You use DEV/PREVIEW/STAGING/PROD in bullets (Line 54-56) and “Development, Staging, Preview, Production” later (Line 92). Pick one style (title case is clearer in prose).

-**[Multiple environments](...#dev-mode)** - Support for DEV, PREVIEW, STAGING, and PROD environments
+**[Multiple environments](...#dev-mode)** - Support for Development, Preview, Staging, and Production environments

The later section (Line 92) already uses title case—no change needed there if you adopt this style.

Also applies to: 92-93


94-99: Terminology: job vs task

You’ve shifted messaging to “tasks.” Consider “Full visibility of every task run.”

-## Full visibility of every job run
+## Full visibility of every task run
packages/trigger-sdk/README.md (2)

34-36: Remove trailing punctuation in heading

“## Key Components:” → “## Key components” (no colon; sentence case to match other headings).

-## Key Components:
+## Key components

Also consider consistent casing with “Core features”.


36-39: Consistent capitalization within list

You use “Build Extensions” capitalized amid other sentence-cased items. Prefer sentence case for consistency.

-- Build Extensions: Customize builds (Prisma, Python, FFmpeg, etc.)
+- Build extensions: Customize builds (Prisma, Python, FFmpeg, etc.)
📜 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 1087e5e and e9a76d9.

📒 Files selected for processing (3)
  • README.md (3 hunks)
  • packages/cli-v3/README.md (2 hunks)
  • packages/trigger-sdk/README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (8)
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Import Trigger.dev APIs from "trigger.dev/sdk/v3" when writing tasks or related utilities

Applied to files:

  • packages/trigger-sdk/README.md
  • packages/cli-v3/README.md
  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Define tasks using task({ id, run, ... }) with a unique id per project

Applied to files:

  • packages/trigger-sdk/README.md
  • packages/cli-v3/README.md
  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use schedules.task(...) for scheduled (cron) tasks; do not implement schedules as plain task() with external cron logic

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Export every task (including subtasks) defined with task(), schedules.task(), or schemaTask()

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Do not use client.defineJob or any deprecated v2 patterns (e.g., eventTrigger) when defining tasks

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use triggerAndWait() only from within a task context (not from generic app code) and handle result.ok or use unwrap() with error handling

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : For idempotent child-task invocations, create and pass idempotencyKey (and optional TTL) when calling trigger()/batchTrigger() from tasks

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : When triggering a task multiple times in a loop from inside another task, use batchTrigger()/batchTriggerAndWait() instead of per-item trigger() calls

Applied to files:

  • README.md
🪛 LanguageTool
packages/trigger-sdk/README.md

[grammar] ~9-~9: There might be a mistake here.
Context: .../www.npmjs.com/package/@trigger.dev/sdk) [![GitHub stars](https://img.shields.io/...

(QB_NEW_EN)


[grammar] ~10-~10: There might be a mistake here.
Context: ...://github.com/triggerdotdev/trigger.dev) [![TypeScript](https://img.shields.io/ba...

(QB_NEW_EN)


[grammar] ~11-~11: There might be a mistake here.
Context: ...1.svg)](https://www.typescriptlang.org/) [![License: MIT](https://img.shields.io/...

(QB_NEW_EN)


[grammar] ~29-~29: There might be a mistake here.
Context: ... features - Task creation and execution - CLI for development and deployment - Bui...

(QB_NEW_EN)


[grammar] ~30-~30: There might be a mistake here.
Context: ...ion - CLI for development and deployment - Build system with extensions - Managemen...

(QB_NEW_EN)


[grammar] ~31-~31: There might be a mistake here.
Context: ...eployment - Build system with extensions - Management API for runs, schedules, and ...

(QB_NEW_EN)


[grammar] ~36-~36: There might be a mistake here.
Context: ...nd jobs written in TypeScript/JavaScript - CLI: Commands for login, init, dev, depl...

(QB_NEW_EN)


[grammar] ~37-~37: There might be a mistake here.
Context: ...I: Commands for login, init, dev, deploy - Build Extensions: Customize builds (Pris...

(QB_NEW_EN)


[grammar] ~38-~38: There might be a mistake here.
Context: ...ze builds (Prisma, Python, FFmpeg, etc.) - Management API: Programmatic control ove...

(QB_NEW_EN)

packages/cli-v3/README.md

[grammar] ~9-~9: There might be a mistake here.
Context: ...tps://www.npmjs.com/package/trigger.dev) [![GitHub stars](https://img.shields.io/...

(QB_NEW_EN)


[grammar] ~10-~10: There might be a mistake here.
Context: ...://github.com/triggerdotdev/trigger.dev) [![TypeScript](https://img.shields.io/ba...

(QB_NEW_EN)


[grammar] ~11-~11: There might be a mistake here.
Context: ...1.svg)](https://www.typescriptlang.org/) [![License: ](https://img.shields.io/bad...

(QB_NEW_EN)

README.md

[grammar] ~10-~10: There might be a mistake here.
Context: ...gerdotdev/trigger.dev/blob/main/LICENSE) [![npm](https://img.shields.io/npm/v/@tr...

(QB_NEW_EN)


[style] ~34-~34: Try using a synonym here to strengthen your writing.
Context: ...ks until a human can approve, reject or give feedback. - **Realtime apps & streamin...

(GIVE_PROVIDE)

🪛 markdownlint-cli2 (0.17.2)
packages/trigger-sdk/README.md

40-40: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

README.md

40-40: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

⏰ 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). (23)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (8)
packages/cli-v3/README.md (3)

40-42: New command docs: check link targets exist

The new entries “preview archive”, “promote”, and “switch” look great. Please verify the docs pages resolve and use consistent slug patterns with the rest of CLI docs.

Optionally add a docs link check in CI (e.g., markdown-link-check) scoped to packages/**/README.md.


1-17: Branding/header changes LGTM

Centered logo, badges, and consolidated navigation improve readability. Good cleanup.


12-12: ✅ License badge verified

The MIT badge in packages/cli-v3/README.md correctly reflects the "license": "MIT" declared in packages/cli-v3/package.json. No changes are needed.

README.md (2)

106-108: Docs link versioning

“How it works” links to /docs/v3/how-it-works while other links use non-versioned paths. Confirm that /v3 is intentional and won’t drift from the other links over time.

If the canonical URL is non-versioned, prefer that to avoid future breakage.


20-39: Content/narrative update LGTM

Clear value props (no timeouts, durability, human-in-the-loop, streaming) read well and align with the AI-agent focus.

packages/trigger-sdk/README.md (3)

43-47: Getting started paths LGTM

Two clear on-ramps (cloud onboarding and manual setup) are helpful. Nice.


8-16: Badges/navigation block LGTM

Cohesive, consistent with CLI README. Good update.


12-12: License badge matches package.json

Verified that packages/trigger-sdk/package.json declares "license": "MIT" and the README badge on line 12 reflects MIT. No changes needed.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

67-84: Ensure v4 uses root SDK imports and update enforcement rules

I’ve verified that the v4 SDK’s package.json (packages/trigger-sdk/package.json) exports . to the v3 entrypoint, so import { … } from "@trigger.dev/sdk" will continue to resolve the v3 API surface.

However, the repository still enforces and documents the old /v3 path in several places. To fully land this change:

• Update the writing-tasks enforcement rule

  • File: .cursor/rules/writing-tasks.mdc
  • Change every “You MUST use @trigger.dev/sdk/v3” to “You MUST use @trigger.dev/sdk
  • Update all example snippets in that rule from import … from "@trigger.dev/sdk/v3" to import … from "@trigger.dev/sdk"

• Sweep v4-targeted examples and docs for /v3 imports

  • README.md (already updated)
  • All docs/**/*.mdx or .md pages under v4 guides (e.g. how-to-reduce-your-spend, realtime, runs)
  • Replace import { … } from "@trigger.dev/sdk/v3" with root imports

• Leave v3-specific docs and tools alone

  • Migration guides (migrating-from-v3.mdx, upgrade-to-v4.mdx)
  • v3 OpenAPI spec (docs/v3-openapi.yaml)
  • packages/cli-v3 and other v3-only fixtures/examples

Once those refactors are in place, all examples, enforcement rules, and v4 documentation will consistently use the root SDK import.

🧹 Nitpick comments (9)
README.md (9)

22-22: Tighten the tagline to avoid a sentence fragment

The second sentence is a fragment. Merging with an em dash keeps the punchy style while reading cleanly.

-Trigger.dev is the open-source platform for building AI workflows in TypeScript. Long-running tasks with retries, queues, observability, and elastic scaling.
+Trigger.dev is the open‑source platform for building AI workflows in TypeScript—long‑running tasks with retries, queues, observability, and elastic scaling.

34-34: Oxford comma and stronger verb

Minor grammar/style polish.

-- **Human-in-the-loop**: Programmatically pause your tasks until a human can approve, reject or give feedback.
+- **Human-in-the-loop**: Programmatically pause your tasks until a human can approve, reject, or provide feedback.

36-36: Standardize “Real-time” spelling

Elsewhere you use “Real-time alerts” (Line 65). Recommend consistent hyphenation here.

-- **Realtime apps & streaming**: Move your background jobs to the foreground by subscribing to runs or streaming AI responses to your app.
+- **Real-time apps & streaming**: Move your background jobs to the foreground by subscribing to runs or streaming AI responses to your app.

40-40: Remove trailing colon in heading to satisfy markdownlint (MD026)

Matches the linter hint and keeps headings consistent.

-## Key features:
+## Key features

42-66: Bullet punctuation consistency

Bullets mix sentence fragments and full sentences (e.g., “Build extensions … customize the build process. Run Python scripts …”). Consider either:

  • Making all bullets fragments without ending periods, or
  • Converting to full sentences that end with periods.

Right now it’s mixed; pick one for consistency. I can draft a normalized pass if helpful.


92-92: Align environment naming and order with earlier references

Earlier (Line 55) you list “DEV, PREVIEW, STAGING, PROD”. Here it’s “Development, Staging, Preview, Production”. Recommend consistent order and casing across the README. One option:

-We support `Development`, `Staging`, `Preview`, and `Production` environments, allowing you to test your tasks before deploying them to production.
+We support `Development`, `Preview`, `Staging`, and `Production` environments, allowing you to test your tasks before deploying them to production.

If you prefer short codes, consider: “DEV, PREVIEW, STAGING, PROD” with a note mapping to full names.


98-98: Asset stability and performance

Consider hosting key images in-repo (or with versioned URLs) to avoid accidental regressions if the CDN path changes. If possible, provide a WebP version for faster loads.


100-100: Use H2 for “Getting started” to keep a single H1 in the README

Maintains heading hierarchy and improves TOC structure.

-# Getting started
+## Getting started

14-14: Optional: update “Twitter” badge label to reflect X rebrand

Purely cosmetic; the link works either way.

-[![Twitter Follow](https://img.shields.io/twitter/follow/triggerdotdev?style=social)](https://twitter.com/triggerdotdev)
+[![Follow on X (Twitter)](https://img.shields.io/twitter/follow/triggerdotdev?style=social)](https://twitter.com/triggerdotdev)
📜 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 e9a76d9 and 99b7e5d.

📒 Files selected for processing (1)
  • README.md (3 hunks)
🧰 Additional context used
🧠 Learnings (8)
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Define tasks using task({ id, run, ... }) with a unique id per project

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Import Trigger.dev APIs from "trigger.dev/sdk/v3" when writing tasks or related utilities

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use schedules.task(...) for scheduled (cron) tasks; do not implement schedules as plain task() with external cron logic

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Export every task (including subtasks) defined with task(), schedules.task(), or schemaTask()

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Do not use client.defineJob or any deprecated v2 patterns (e.g., eventTrigger) when defining tasks

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use triggerAndWait() only from within a task context (not from generic app code) and handle result.ok or use unwrap() with error handling

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : For idempotent child-task invocations, create and pass idempotencyKey (and optional TTL) when calling trigger()/batchTrigger() from tasks

Applied to files:

  • README.md
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : When triggering a task multiple times in a loop from inside another task, use batchTrigger()/batchTriggerAndWait() instead of per-item trigger() calls

Applied to files:

  • README.md
🪛 LanguageTool
README.md

[grammar] ~10-~10: There might be a mistake here.
Context: ...gerdotdev/trigger.dev/blob/main/LICENSE) [![npm](https://img.shields.io/npm/v/@tr...

(QB_NEW_EN)


[style] ~34-~34: Try using a synonym here to strengthen your writing.
Context: ...ks until a human can approve, reject or give feedback. - **Realtime apps & streamin...

(GIVE_PROVIDE)


[grammar] ~107-~107: There might be a mistake here.
Context: ...and how Trigger.dev works under the hood - [Guides and examples](https://trigger.dev...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)
README.md

40-40: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

⏰ 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). (23)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
README.md (1)

75-83: Nice: explicit export and clear task scaffolding

Exporting the task and calling out unique IDs aligns with our authoring guidance. Example is concise and accurate.

@D-K-P D-K-P merged commit 84750f6 into main Aug 21, 2025
31 checks passed
@D-K-P D-K-P deleted the readme-updates branch August 21, 2025 11:28
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