Skip to content

Commit

Permalink
docs: document log order (#5463)
Browse files Browse the repository at this point in the history
### Description

Adds documentation for `--log-order` #3916 including a callout of our
special behavior on Github Actions.

### Testing Instructions

Eyes

---------

Co-authored-by: Chris Olszewski <Chris Olszewski>
  • Loading branch information
chris-olszewski authored Jul 17, 2023
1 parent 0771b80 commit 78f6cc8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/pages/repo/docs/reference/command-line-reference/run.mdx
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 |
| 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

1 comment on commit 78f6cc8

@vercel
Copy link

@vercel vercel bot commented on 78f6cc8 Jul 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.