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.

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

Documentation for output-style option doesn't explain choices #20159

Closed
1 of 4 tasks
jaufgang opened this issue Nov 9, 2023 · 4 comments · Fixed by #23521
Closed
1 of 4 tasks

Documentation for output-style option doesn't explain choices #20159

jaufgang opened this issue Nov 9, 2023 · 4 comments · Fixed by #23521
Assignees
Labels
scope: docs Issues related to generic docs type: docs

Comments

@jaufgang
Copy link
Contributor

jaufgang commented Nov 9, 2023

Documentation issue

  • Reporting a typo
  • Reporting a documentation bug
  • Documentation improvement
  • Documentation feedback

Is there a specific documentation page you are reporting?

Additional context or description

The documentation for the output-style option doesn't provide any explanation as to what the differences are between the different choices, or which one is the default behaviour. A brief explanation of how each choice affects the output would be helpful to users unfamiliar with this option. Some visual examples of the different output styles would also be helpful.

image
@FrozenPandaz FrozenPandaz added the scope: docs Issues related to generic docs label Nov 10, 2023
@DanLatimer
Copy link

DanLatimer commented Mar 4, 2024

For other people who got here looking for what these mean until they get around to updating the docs I've figured out what stream is and it's what I want so I'm stopping there.

Instead of hiding the logs until the task is done and outputting them then, it streams the logs from each task prefixed with the task name at the start of the log line. I assume stream without prefixes does the same without the prefixes.

No idea what dynamic and static mean, presumably one of them is the default

@zbentzinger
Copy link

Also got here trying to understand the choices.

@zhangciwu
Copy link

Using --output-style=stream resolves an issue where the log is incomplete in Github CI when operating in normal output style.

@JakeGinnivan
Copy link
Contributor

I've hit the same issue with GitHub action where the output is cut off. Assume it's some sort of issue where there is too much output in a short time for GitHub actions so it doesn't get picked up.

AgentEnder pushed a commit that referenced this issue May 27, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

## Current Behavior
<!-- This is the behavior we have today -->

`output-style` option's potential values are not explained.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

add description to `output-style` option's potential values

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #20159


![image](https://github.com/nrwl/nx/assets/5159834/15406dcf-80c3-444c-881a-268fcf9704e5)
FrozenPandaz pushed a commit that referenced this issue May 28, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

## Current Behavior
<!-- This is the behavior we have today -->

`output-style` option's potential values are not explained.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

add description to `output-style` option's potential values

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #20159

![image](https://github.com/nrwl/nx/assets/5159834/15406dcf-80c3-444c-881a-268fcf9704e5)

(cherry picked from commit e32b819)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Issues related to generic docs type: docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants