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

fix(compute/build): ensure build output doesn't show unless --verbose flag is set #815

Merged
merged 1 commit into from Feb 13, 2023

Conversation

Integralist
Copy link
Collaborator

@Integralist Integralist commented Feb 13, 2023

Problem

When there is an error building a user's project, the build output is displayed to the user and is so visually noisy you can’t see the list of instructions for how to debug things when there is an error.

The following screenshot isn't even that bad of an example as the error output from my example is actually quite short, whereas in practice the output is usually a lot denser and harder to scan, but it's still a useful example of how hard it is 'at a glance' to distinguish the various output categories (expected/unexpected/error/guidance)...

Screenshot 2023-02-13 at 13 32 47

Solution

Only show the build output/error when the --verbose flag is set.

Context

Prior versions of the CLI would default to displaying the build output because users didn't know they could pass --verbose to see the build output and get more information. But since 6.x the CLI no longer validates a user's environment, and instead if there is an error building, we just display a bullet list of suggestions. So the current behaviour results in lots of output by default and makes knowing where to look for guidance much harder!

Screenshots

The first screenshot shows what happens when the user runs compute build and there is a build error (notice the output is much more succinct and clear)...

Screenshot 2023-02-13 at 13 09 06

The second screenshot shows what happens if the user follows our guidance and re-runs the command with the --verbose set (notice the extra contextual information and a clearly marked/delimited section for the command's output so users can more easily identify build information and build output)...

Screenshot 2023-02-13 at 13 40 00

The last screenshot shows us fixing the issue and then what the output of compute build now looks like when it's successful, both with and without the --verbose flag...

Screenshot 2023-02-13 at 13 42 13

@Integralist Integralist added the enhancement New feature or request label Feb 13, 2023
@Integralist Integralist merged commit 95d9a76 into main Feb 13, 2023
@Integralist Integralist deleted the integralist/build-output branch February 13, 2023 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant