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

Generic "error" message telling you to come here to write an issue and/or update the CLI #391

Closed
fernando-villalba opened this issue Apr 25, 2024 · 0 comments · Fixed by #458

Comments

@fernando-villalba
Copy link
Contributor

fernando-villalba commented Apr 25, 2024

Issue

A lot of the errors in the CLI have the following generic error message:

Please check if you are using the latest version of CLI and retry the command 
If you are still facing issues, please report it on our community slack or open a GitHub issue (https://github.com/civo/cli/issues) 

For example:

$ civo kubernetes create --merge              
Please check if you are using the latest version of CLI and retry the command 
If you are still facing issues, please report it on our community slack or open a GitHub issue (https://github.com/civo/cli/issues) 
Error: you can't use --save, --switch or --merge without --wait

There are multiple issues here:

1. The generic error message does not go to stderr

For example:

$ civo kubernetes create --merge 2> /dev/null
Please check if you are using the latest version of CLI and retry the command 
If you are still facing issues, please report it on our community slack or open a GitHub issue (https://github.com/civo/cli/issues) 

All logging of this kind should go to stderr!

2. This error message is meaningless is most contexts

In the above example and in every situation I came across this error message, it was in the context of known errors due to missing flags or the like. Not due to a CLI issue that needed that required writing a GitHub issue for it.

Acceptance Criteria

  • Only use this error message when the error is unknown and output it to stderr
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant