Parallel beta docs #14445
Parallel beta docs #14445
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes introduce a new "Parallel" control flow operator to the workflow documentation. A new entry has been added to the control flow options in the JSON metadata, and a comprehensive guide detailing the functionality of the Parallel operator has been created. This includes instructions for defining multiple execution branches, managing data exports, and testing workflows, enhancing the existing control flow options. Changes
Poem
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: 1
🧹 Outside diff range and nitpick comments (3)
docs-v2/pages/workflows/control-flow/parallel.mdx (3)
1-3: Remove unused VideoPlayer import.The
VideoPlayercomponent is imported but not used in this document.import Callout from '@/components/Callout' -import VideoPlayer from "@/components/VideoPlayer"; import { Steps } from 'nextra/components'
9-9: Improve readability with proper punctuation.Add a comma before "and" in the compound sentence for better readability.
-**Parallel** is multi-path branching operator. It allows you to create multiple execution branches with optional filtering rules and Pipedream will execute **all** matching branches. +**Parallel** is multi-path branching operator. It allows you to create multiple execution branches with optional filtering rules, and Pipedream will execute **all** matching branches.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...cution branches with optional filtering rules and Pipedream will execute all matc...(AI_HYDRA_LEO_MISSING_COMMA)
49-51: Consider making the beta limitations more prominent.Given the potential impact on workflow execution, consider converting this section to a warning callout for better visibility.
### Beta Limitations -Workflow queue settings (concurrency, execution rate) may not work as expected with workflows using the parallel operator. +<Callout type="warning"> +Workflow queue settings (concurrency, execution rate) may not work as expected with workflows using the parallel operator. +</Callout>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (11)
docs-v2/pages/workflows/control-flow/images/parallel/01_trigger.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/02_add_parallel.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/03_configure_and_test.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/04_add_steps.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/05_test_end_phase.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/06_use_exports_in_parent_flow.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/07_deploy_and_run.gifis excluded by!**/*.gifdocs-v2/pages/workflows/control-flow/images/parallel/add_branch.pngis excluded by!**/*.pngdocs-v2/pages/workflows/control-flow/images/parallel/add_parallel_block.pngis excluded by!**/*.pngdocs-v2/pages/workflows/control-flow/images/parallel/parallel.pngis excluded by!**/*.pngdocs-v2/pages/workflows/control-flow/images/parallel/rename_branch.pngis excluded by!**/*.png
📒 Files selected for processing (2)
- docs-v2/pages/workflows/control-flow/_meta.json (1 hunks)
- docs-v2/pages/workflows/control-flow/parallel.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/workflows/control-flow/parallel.mdx
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...cution branches with optional filtering rules and Pipedream will execute all matc...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
docs-v2/pages/workflows/control-flow/_meta.json (1)
5-5: LGTM! Well-structured addition to the control flow options.The new "parallel" entry follows the established naming conventions and is appropriately grouped with other branching operations. The format and placement are consistent with the existing structure.
docs-v2/pages/workflows/control-flow/parallel.mdx (1)
53-99: Well-structured getting started guide!The step-by-step guide with visual demonstrations is comprehensive and effectively guides users through the setup process.
| ### Export Data to the Parent Flow | ||
|
|
||
| You can export data from a parallel operation and continue execution in the parent flow. | ||
| - The parallel block exports data as a JSON object | ||
| - Branch exports are assigned to a key corresponding to the branch name slug (in the object exported from the block) | ||
| - Only the exports from the last step of each executed branch are included in the parallel block's return value | ||
| - To preview the exported data, test the **End** phase of the parallel block | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add a code example for data exports.
Consider adding a simple code example showing the structure of exported data to help users better understand how the data is organized.
### Export Data to the Parent Flow
You can export data from a parallel operation and continue execution in the parent flow.
- The parallel block exports data as a JSON object
- Branch exports are assigned to a key corresponding to the branch name slug (in the object exported from the block)
- Only the exports from the last step of each executed branch are included in the parallel block's return value
- To preview the exported data, test the **End** phase of the parallel block
+For example, if you have branches named "process_orders" and "send_notifications", the exported data might look like:
+```json
+{
+ "process_orders": {
+ "processed_count": 42,
+ "status": "success"
+ },
+ "send_notifications": {
+ "sent_count": 10,
+ "failed_count": 0
+ }
+}
+```
WHY
Summary by CodeRabbit
New Features
Documentation