feat: sibling tasks #9504
Merged
feat: sibling tasks #9504
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
8 Skipped Deployments
|
tknickman
approved these changes
Nov 25, 2024
|
|
||
| /// Adds a sibling relationship from task to sibling | ||
| pub fn with_sibling(&mut self, task: TaskName<'static>, sibling: &TaskName) { | ||
| if self.extends.is_empty() { |
There was a problem hiding this comment.
What's the reason for this? Do we only add siblings to workspace configs?
There was a problem hiding this comment.
At this moment, yes.
There was a problem hiding this comment.
Could we document this then?
Co-authored-by: Nicholas Yang <nicholas.yang@vercel.com>
1 task
chris-olszewski
added a commit
that referenced
this pull request
Mar 18, 2025
### Description Make public the feature added in #9504 that allows for pulling in extra tasks into the graph without a `dependsOn` relationship. Renamed to `with` as it is better than `sibling` since that indicates a shared parent, which isn't required. ### Testing Instructions Added quick unit test for parsing and error validation. Basic test: ``` [0 olszewski@macbookpro] /tmp/with-test $ git diff diff --git a/turbo.json b/turbo.json index d6a7fe0..35fa9cd 100644 --- a/turbo.json +++ b/turbo.json @@ -15,7 +15,8 @@ }, "dev": { "cache": false, - "persistent": true + "persistent": true, + "with": ["build"] } } } # Verify web#build is in the graph [0 olszewski@macbookpro] /tmp/with-test $ turbo_dev --skip-infer web#dev --graph turbo 2.4.5-canary.4 digraph { compound = "true" newrank = "true" subgraph "root" { "[root] @repo/eslint-config#build" -> "[root] ___ROOT___" "[root] @repo/typescript-config#build" -> "[root] ___ROOT___" "[root] @repo/ui#build" -> "[root] @repo/eslint-config#build" "[root] @repo/ui#build" -> "[root] @repo/typescript-config#build" "[root] web#build" -> "[root] @repo/eslint-config#build" "[root] web#build" -> "[root] @repo/typescript-config#build" "[root] web#build" -> "[root] @repo/ui#build" "[root] web#dev" -> "[root] ___ROOT___" } } ``` Error message for trying to use `^` ``` [0 olszewski@macbookpro] /tmp/with-test $ turbo_dev --skip-infer web#dev turbo 2.4.5-canary.4 × Invalid turbo.json configuration ╰─▶ × `with` cannot use topological dependencies. ╭─[turbo.json:19:16] 18 │ "persistent": true, 19 │ "with": ["^build"] · ────┬─── · ╰── Remove `^` from start of task name. 20 │ } ╰──── ``` --------- Co-authored-by: Anthony Shew <anthony.shew@vercel.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR does 2 things:
siblingattribute for task definitions that has the ability to bring another task into the graph without depending on it. This is currently only an attribute that can be set by us inside Rust, but I hope this use case proves useful enough to eventually make this a public API.siblingswhere each dev task gets a"siblings": ["mfe-pkg#proxy"]to ensure the proxy gets run.A sibling relationship acts similar to
dependsOnexcept that it will not wait for the task to exit before starting and the sibling's task hash will not affect the current task's hash.Currently it's very hard to get
web#proxyto run if the user runs a command liketurbo dev --filter=docsas just addingwebto the filter will meanweb#devgets picked up which isn't what we desire. As you can see inrun/builder.rsthis also removes the need of microfrontend knowledge from building the task graph.Testing Instructions
Added unit tests for sibling behavior as well as unit tests for MFE task injection.
Manual testing for the MFE behavior to make sure proxy still gets picked up.