Skip to content

Commit 2b1e7f0

Browse files
authored
docs: Move deprecated options for run command to bottom (#5180)
1 parent eaf20a2 commit 2b1e7f0

File tree

1 file changed

+78
-67
lines changed
  • docs/pages/repo/docs/reference/command-line-reference

1 file changed

+78
-67
lines changed

docs/pages/repo/docs/reference/command-line-reference/run.mdx

+78-67
Original file line numberDiff line numberDiff line change
@@ -57,25 +57,6 @@ Set the working directory of the command.
5757
turbo run build --cwd=./somewhere/else
5858
```
5959

60-
### `--deps`
61-
62-
<Callout type="error">
63-
`--deps` is deprecated in `1.2.x`. Please use
64-
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#include-dependents-of-matched-workspaces)
65-
instead.
66-
</Callout>
67-
68-
Defaults to `true`. Include dependent workspace consumers in the execution.
69-
70-
```sh
71-
turbo run build --deps
72-
turbo run build --no-deps
73-
```
74-
75-
**Example**
76-
77-
Let's say you have workspaces A, B, C, and D where A depends on B and C depends on D. You run `turbo run build` for the first time and everything is built and cached. Then, you change a line of code in B. With the `--deps` flag on, running `turbo run build` will execute `build` in B and then A, but not in C and D because they are not impacted by the change. If you were to run `turbo run build --no-deps` instead, turbo will only run `build` in B.
78-
7960
### `--dry / --dry-run`
8061

8162
Instead of executing tasks, display details about the affected workspaces and tasks that would be run.
@@ -245,18 +226,6 @@ Just a quick overview.
245226
- `{}` allows for a comma-separated list of "or" expressions
246227
- `!` at the beginning of a pattern will negate the match
247228

248-
### `--include-dependencies`
249-
250-
<Callout type="error">
251-
`--include-dependencies` is deprecated in `1.2.x`. Please use
252-
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#include-dependencies-of-matched-workspaces)
253-
instead.
254-
</Callout>
255-
256-
Default `false`. When `true`, `turbo` will add any workspaces that the workspaces in the current execution _depend_ on (i.e. those declared in `dependencies` or `devDependencies`).
257-
258-
This is useful when using `--filter` in CI as it guarantees that every dependency needed for the execution is actually executed.
259-
260229
### `--no-cache`
261230

262231
Default `false`. Do not cache results of the task. This is useful for watch commands like `next dev` or `react-scripts start`.
@@ -340,42 +309,6 @@ turbo run build --remote-only
340309

341310
The same behavior can also be set via the `TURBO_REMOTE_ONLY=true` environment variable.
342311

343-
### `--scope`
344-
345-
<Callout type="error">
346-
`--scope` is deprecated in `1.2.x`. Please use
347-
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#filter-by-package) instead.
348-
</Callout>
349-
350-
`type: string[]`
351-
352-
Specify/filter workspaces to act as entry points for execution. Globs against `package.json` `name` field (and not the file system.)
353-
354-
```sh
355-
turbo run lint --scope="@example/**"
356-
turbo run dev --scope="@example/a" --scope="@example/b" --no-cache --no-deps
357-
```
358-
359-
### `--since`
360-
361-
<Callout type="error">
362-
`--since` is deprecated in `1.2.x`. Please use
363-
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#filter-by-changed-workspaces)
364-
instead.
365-
</Callout>
366-
367-
Filter execution based on which workspaces have changed since a merge-base.
368-
369-
```
370-
turbo run build --since=origin/main
371-
```
372-
373-
<Callout type="info">
374-
**Important**: This uses the `git diff ${target_branch}...` mechanism to
375-
identify which workspaces have changed. There is an assumption that all the
376-
input files for a workspace exist inside their respective workspace folders.
377-
</Callout>
378-
379312
### `--summarize`
380313

381314
Generates a JSON file in `.turbo/runs` containing metadata about the run, including affected workspaces,
@@ -475,5 +408,83 @@ turbo run build --verbosity=2
475408
turbo run build -vvv
476409
```
477410

411+
## Deprecated Options
412+
413+
### `--include-dependencies`
414+
415+
<Callout type="error">
416+
`--include-dependencies` is deprecated in `1.2.x`. Please use
417+
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#include-dependencies-of-matched-workspaces)
418+
instead.
419+
</Callout>
420+
421+
Default `false`. When `true`, `turbo` will add any workspaces that the
422+
workspaces in the current execution _depend_ on (i.e. those declared in
423+
`dependencies` or `devDependencies`).
424+
425+
This is useful when using `--filter` in CI as it guarantees that every
426+
dependency needed for the execution is actually executed.
427+
428+
### `--deps`
429+
430+
<Callout type="error">
431+
`--deps` is deprecated in `1.2.x`. Please use
432+
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#include-dependents-of-matched-workspaces)
433+
instead.
434+
</Callout>
435+
436+
Defaults to `true`. Include dependent workspace consumers in the execution.
437+
438+
```sh
439+
turbo run build --deps
440+
turbo run build --no-deps
441+
```
442+
443+
**Example**
444+
445+
Let's say you have workspaces A, B, C, and D where A depends on B and C depends
446+
on D. You run `turbo run build` for the first time and everything is built and
447+
cached. Then, you change a line of code in B. With the `--deps` flag on, running
448+
`turbo run build` will execute `build` in B and then A, but not in C and D
449+
because they are not impacted by the change. If you were to run
450+
`turbo run build --no-deps` instead, turbo will only run `build` in B.
451+
452+
### `--scope`
453+
454+
<Callout type="error">
455+
`--scope` is deprecated in `1.2.x`. Please use
456+
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#filter-by-package) instead.
457+
</Callout>
458+
459+
`type: string[]`
460+
461+
Specify/filter workspaces to act as entry points for execution. Globs against
462+
`package.json` `name` field (and not the file system.)
463+
464+
```sh
465+
turbo run lint --scope="@example/**"
466+
turbo run dev --scope="@example/a" --scope="@example/b" --no-cache --no-deps
467+
```
468+
469+
### `--since`
470+
471+
<Callout type="error">
472+
`--since` is deprecated in `1.2.x`, use
473+
[`--filter`](/repo/docs/core-concepts/monorepos/filtering#filter-by-changed-workspaces)
474+
instead.
475+
</Callout>
476+
477+
Filter execution based on which workspaces have changed since a merge-base.
478+
479+
```
480+
turbo run build --since=origin/main
481+
```
482+
483+
<Callout type="info">
484+
**Important**: This uses the `git diff ${target_branch}...` mechanism to
485+
identify which workspaces have changed. There is an assumption that all the
486+
input files for a workspace exist inside their respective workspace folders.
487+
</Callout>
488+
478489
[1]: /repo/docs/reference/configuration#passThroughEnv
479490
[2]: /repo/docs/reference/configuration#globalPassThroughEnv

0 commit comments

Comments
 (0)