Docs v4 migration guide: Updates the run function param syntax + adds new run.list() example

[samejr]

Summary by CodeRabbit

• Documentation
  • Updated upgrade guide for v4 with clarified lifecycle hook function signatures and updated examples.
  • Documented changes to the ctx object, including removal of certain properties.
  • Added a known issue regarding runs not continuing after child runs complete.
  • Explained new usage for accessing runs from batchTrigger via runs.list(), with updated code examples.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 3c439cc

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.

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]

Walkthrough

The upgrade documentation for version 4 has been revised to clarify lifecycle hook function signatures, update examples for the run function, and document changes to the ctx object. A new section explains the updated behavior of the batchTrigger function, specifically how to access runs asynchronously using the runs.list() method on the batch handle instead of direct property access. The documentation now also highlights a known issue regarding runs not continuing after child runs complete.

Changes

File(s)	Change Summary
docs/upgrade-to-v4.mdx	Updated upgrade guide to clarify lifecycle hook signatures, document ctx changes, explain new batchTrigger usage, and add a known issue section. Includes revised code examples.

Possibly related PRs

• docs: Upgrade to v4 guide #1873: Also modifies the upgrade-to-v4 documentation, focusing on new features and formatting improvements, making it closely related as both PRs update the same guide.

Suggested reviewers

• matt-aitken

Poem

In docs we hop, from v3 to v4,
Updating hooks, examples, and more.
Batch triggers now dance in async delight,
With runs.list() guiding us right.
Known issues are flagged, so none are surprised—
This bunny ensures all is well-documented and wise!
🐇📚✨

---

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

• 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/upgrade-to-v4.mdx (2)

706-707: Nit: Remove extra whitespace in the run signature example
There's an unintended leading space before payload in the code block comment. It should align with the other hooks and match the documented signature.
Apply this diff for consistency:

-  // The run function still uses separate parameters
-  run: async ( payload, { ctx }) => {},
+  // The run function still uses separate parameters
+  run: async (payload, { ctx }) => {},

---

511-511: Optional: Use consistent admonition for known issues
The line

**ISSUE:** Runs not continuing after a child run(s) have completed.

could be formatted using the existing <Note> or <Warning> components for better consistency and visibility. For example:

<Warning>
  Runs may not continue after completing child runs. We are tracking a fix for this issue.
</Warning>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 672a6b8 and 3c439cc.

📒 Files selected for processing (1)

• docs/upgrade-to-v4.mdx (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

docs/upgrade-to-v4.mdx (2)

723-723: Correctly preserved run signature in extended hooks example
This snippet accurately shows that run still takes separate parameters (payload, { ctx }), consistent with the v4 signature change.

---

736-763: BatchTrigger changes section—examples are clear and complete
The new code examples contrast the v3 direct access (batchHandle.runs) with the v4 async list retrieval (await batchHandle.runs.list()), which accurately reflects the API change. No updates needed here.