Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document log order #5463

Merged
merged 4 commits into from
Jul 17, 2023
Merged

docs: document log order #5463

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3d9b64
add docs for log order
Jul 5, 2023
17f22c6
pr feedback
Jul 6, 2023
c21332c
Merge branch 'main' into olszewski/document_log_order
chris-olszewski Jul 7, 2023
fa15cb1
Merge branch 'main' into olszewski/document_log_order
chris-olszewski Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/pages/repo/docs/reference/command-line-reference/run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,32 @@ Just a quick overview.
- `{}` allows for a comma-separated list of "or" expressions
- `!` at the beginning of a pattern will negate the match

### `--log-order`

`type: string`

Set type of task output order. Defaults to "auto" which lets
`turbo` detect if it's running in CI and group logs in that environment while streaming in others.

| option | description |
| ------- | ----------------------------------------- |
| auto | Turbo decides based on its own heuristics |
| stream | show output as soon as it is available |
chris-olszewski marked this conversation as resolved.
Show resolved Hide resolved
| grouped | Show output grouped by task |

**Example**

```shell
turbo run build --log-order=stream
turbo run build --log-order=grouped
```

<Callout type="info">
If log order is set to auto and `turbo` detects that it is running on GitHub Actions, then `turbo` will
create [grouped logs](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines).
You can opt out of this behavior by setting a log order of your own.
</Callout>

### `--no-cache`

Default `false`. Do not cache results of the task. This is useful for watch commands like `next dev` or `react-scripts start`.
Expand Down