New metadata system doc updates #1590
Conversation
|
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
packages/core/src/v3/types/tasks.tsOops! Something went wrong! :( ESLint: 8.45.0 ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct. The config "custom" was referenced from the config file in "/.eslintrc.js". If you still have problems, please stop by https://eslint.org/chat/help to chat with the team. WalkthroughThis pull request introduces significant updates to run metadata documentation and type definitions. The primary change is increasing the maximum metadata size from 4KB to 256KB, which allows for more extensive data storage. The documentation now includes new sections on Fluent API and parent/root metadata updates, providing developers with more flexible ways to manage task metadata. The changes enhance the metadata handling capabilities while maintaining the existing code structure. Changes
Possibly related PRs
Poem
Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/runs/metadata.mdx (1)
401-516: LGTM! Comprehensive documentation for parent & root metadata updates.The new section effectively explains the parent and root metadata update features with clear examples and a practical CSV processing use case.
Consider adding a note about error handling when using
metadata.parentormetadata.rootin tasks that don't have a parent or root task.🧰 Tools
🪛 LanguageTool
[style] ~429-~429: Consider removing “of” to be more concise
Context: ...ent.set("progress", 0.5); }, }); ``` All of the update methods are available on `metada...(ALL_OF_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/runs/metadata.mdx(4 hunks)packages/core/src/v3/types/tasks.ts(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/runs/metadata.mdx
[style] ~383-~383: Consider removing “of” to be more concise
Context: ...a.flush(); }, }); ``` ## Fluent API All of the update methods can be chained together ...
(ALL_OF_THE)
[style] ~429-~429: Consider removing “of” to be more concise
Context: ...ent.set("progress", 0.5); }, }); ``` All of the update methods are available on `metada...
(ALL_OF_THE)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: units / 🧪 Unit Tests
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - npm)
- GitHub Check: typecheck / typecheck
🔇 Additional comments (4)
packages/core/src/v3/types/tasks.ts (1)
766-766: LGTM! Documentation update for metadata size limit.The updated comment correctly reflects the new 256KB metadata size limit.
docs/runs/metadata.mdx (3)
7-7: LGTM! Documentation update for metadata size limit and access methods.The updated text correctly reflects the new 256KB metadata size limit and adds "Realtime" to the list of ways to access metadata.
382-399: LGTM! Clear documentation for the Fluent API feature.The new section effectively demonstrates how to chain multiple metadata update methods together, improving code readability.
🧰 Tools
🪛 LanguageTool
[style] ~383-~383: Consider removing “of” to be more concise
Context: ...a.flush(); }, }); ``` ## Fluent API All of the update methods can be chained together ...(ALL_OF_THE)
627-627: LGTM! Documentation update for metadata size limit configuration.The updated text correctly reflects the new 256KB metadata size limit and provides helpful information about configuring the limit for self-hosted instances.
@trigger.dev/build
@trigger.dev/rsc
@trigger.dev/core
@trigger.dev/sdk
trigger.dev
@trigger.dev/react-hooks
commit: |
Summary by CodeRabbit
Documentation
Improvements