prevent graphql error #258
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mislav
approved these changes
Jan 28, 2020
There was a problem hiding this comment.
This is great; I'm all for helping the user not hit the API errors in the first place.
I'm wondering whether a possible step for improvement could be to ask the user again for a title if it was blank in interactive mode? That way instead of exiting with an error, we offer them a chance to have their PR be successful. This could be a follow-up PR, though.
command/pr_create.go
Outdated
| @@ -174,6 +174,10 @@ func prCreate(cmd *cobra.Command, _ []string) error { | |||
| } | |||
|
|
|||
| if action == SubmitAction { | |||
| if title == "" { | |||
| return fmt.Errorf("Can't create a PR without a title.") | |||
There was a problem hiding this comment.
- In general, we try to not use capitalization or punctuation in error messages (in fact, go-lint warns about this) to make wrapping of errors easier
- Let's use "pull request" instead of PR in user-facing messages
- (nitpick) I generally try to avoid contractions in text UIs, perhaps you'd be open to rewording "can't" as "could not" or something similar? Another way to put this could be "pull request title must not be blank"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this PR catches what would become a graphql error -- a blank PR title upon attempt to create it via the API. A blank title is still legal when previewing in browser (and encouraged, as the expectation is that the user will be filling the title in via the web).
We could take this chance to do something fancy like create a default PR title out of a single commit message but I didn't feel like making a UX decision on that right now; it seemed like handling the graphql error more humanely was good enough for now.
Closes #146