Skip to content

Add Descriptive Error Message to Upgrade Command #752

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

Merged
nywilken merged 2 commits into from
Nov 2, 2018
Merged

Add Descriptive Error Message to Upgrade Command #752

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be7d243
Add Descriptive Error Message to Upgrade Command
farisj Oct 24, 2018
8085d76
Reword Error Message
farisj Oct 25, 2018
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
9 changes: 8 additions & 1 deletion cmd/upgrade.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@ You can always delete this file.
`,
RunE: func(cmd *cobra.Command, args []string) error {
c := cli.New(Version)
return updateCLI(c)
err := updateCLI(c)
if err != nil {
err = fmt.Errorf(`We were not able to upgrade the cli because we encountered an error: %s
Copy link
Copy Markdown
Contributor

@nywilken nywilken Oct 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

No need to reassign err here. Lets return the error message immediately to fail the command.

This is how the current error message will be displayed to the user.

Error: We were not able to upgrade the cli because we encountered an error: <error message>
Please check the FAQ for solutions to common upgrading issues.

Could you move the message down one line and reword the messaging a bit so that it doesn't contain error:.

Error:

We were not able to upgrade the cli....
<error message>

Please check the FAQ for solutions to common upgrading issues. 

https://exercism.io/faqs

Please check the FAQ for solutions to common upgrading issues.

https://exercism.io/faqs`, err)
}
return err
Copy link
Copy Markdown
Contributor

@nywilken nywilken Oct 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Seeing as we check for the error above lets return fmt.Errorf(...) within the condition and just return nil here.

},
}

Expand Down