docs: Max duration

[ericallam]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced maxDuration configuration option for tasks, allowing users to set a maximum execution time (default 60 seconds).
  • Added support for new build extensions: audioWaveform, puppeteer, ffmpeg, and aptGet.

• Documentation

  • Expanded documentation on maxDuration, including implementation examples and best practices for task triggering.
  • Enhanced clarity in various documentation files related to task triggering methods and configurations.

• Style

  • Improved formatting for better readability in documentation files.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 553c58e2d75b3932225d07e7d65d3eff70d060ad

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

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several updates to the documentation and configuration files related to the maxDuration feature for tasks within the Trigger framework. Key changes include the addition of the maxDuration configuration option in trigger.config.ts, detailed documentation on how to implement this feature, and the introduction of several build extensions. Additionally, formatting improvements have been made to various JSON files for better readability. New examples have been added to templates to illustrate the use of maxDuration in scheduled and simple tasks.

Changes

File Path	Change Summary
docs/config/config-file.mdx	Updated to include maxDuration configuration option and examples for build extensions: audioWaveform, puppeteer, ffmpeg, aptGet.
docs/mint.json	Formatting changes for improved readability of array elements.
docs/runs/max-duration.mdx	New documentation for configuring maxDuration for tasks, including examples and context-specific usage.
docs/tasks/overview.mdx	Added maxDuration option for tasks with an example; standardized <Info> tag formatting.
docs/triggering.mdx	Enhanced documentation on task triggering methods with new sections and detailed explanations of parameters.
packages/cli-v3/templates/examples/schedule.mjs.template	Added maxDuration: 300 to firstScheduledTask.
packages/cli-v3/templates/examples/schedule.ts.template	Added maxDuration: 300 to firstScheduledTask.
packages/cli-v3/templates/examples/simple.mjs.template	Added maxDuration: 300 to helloWorldTask.
packages/cli-v3/templates/examples/simple.ts.template	Added maxDuration: 300 to helloWorldTask.
packages/cli-v3/templates/trigger.config.mjs.template	Added comments regarding maxDuration configuration; property remains commented out.
packages/cli-v3/templates/trigger.config.ts.template	Added comments regarding maxDuration configuration; property remains commented out.
references/v3-catalog/trigger.config.ts	Changed commented-out maxDuration from 60 to 300.

Possibly related PRs

• #1379: This PR directly relates to the main PR as it updates the documentation for the trigger.config.ts file to include a new section on setting the default maxDuration for tasks, which is a key change highlighted in the main PR.

Suggested reviewers

• matt-aitken

Poem

🐇 In the meadow where tasks do play,
A new maxDuration leads the way.
With seconds counted, they hop and run,
Ensuring each task is quick and fun!
So gather 'round, let’s celebrate,
For time well spent makes tasks first-rate! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

Documentation and Community

• 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.

[pkg-pr-new[bot]]

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1379

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev@1379

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1379

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1379

commit: 553c58e