Exit with status code "2" on user cancellation errors

mislav · mislav · commit 2ebdde1ddd0b · 2021-03-02T13:48:44.000+01:00
This also stops printing "interrupt" after Ctrl-C is pressed.
diff --git a/cmd/gh/main.go b/cmd/gh/main.go
@@ -148,6 +148,12 @@ func main() {
 	rootCmd.SetArgs(expandedArgs)
 
 	if cmd, err := rootCmd.ExecuteC(); err != nil {
+		if err == cmdutil.SilentError {
+			os.Exit(1)
+		} else if cmdutil.IsUserCancellation(err) {
+			os.Exit(2)
+		}
+
 		printError(stderr, err, cmd, hasDebug)
 
 		var httpErr api.HTTPError
@@ -177,10 +183,6 @@ func main() {
 }
 
 func printError(out io.Writer, err error, cmd *cobra.Command, debug bool) {
-	if err == cmdutil.SilentError {
-		return
-	}
-
 	var dnsError *net.DNSError
 	if errors.As(err, &dnsError) {
 		fmt.Fprintf(out, "error connecting to %s\n", dnsError.Name)
diff --git a/pkg/cmd/gist/edit/edit.go b/pkg/cmd/gist/edit/edit.go
@@ -177,7 +177,7 @@ func editRun(opts *EditOptions) error {
 		case "Submit":
 			stop = true
 		case "Cancel":
-			return cmdutil.SilentError
+			return cmdutil.CancelError
 		}
 
 		if stop {
diff --git a/pkg/cmd/issue/create/create.go b/pkg/cmd/issue/create/create.go
@@ -249,7 +249,7 @@ func createRun(opts *CreateOptions) (err error) {
 
 		if action == prShared.CancelAction {
 			fmt.Fprintln(opts.IO.ErrOut, "Discarding.")
-			err = cmdutil.SilentError
+			err = cmdutil.CancelError
 			return
 		}
 	} else {
diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go
@@ -299,7 +299,7 @@ func createRun(opts *CreateOptions) (err error) {
 
 	if action == shared.CancelAction {
 		fmt.Fprintln(opts.IO.ErrOut, "Discarding.")
-		err = cmdutil.SilentError
+		err = cmdutil.CancelError
 		return
 	}
 
@@ -542,7 +542,7 @@ func NewCreateContext(opts *CreateOptions) (*CreateContext, error) {
 		} else if pushOptions[selectedOption] == "Skip pushing the branch" {
 			isPushEnabled = false
 		} else if pushOptions[selectedOption] == "Cancel" {
-			return nil, cmdutil.SilentError
+			return nil, cmdutil.CancelError
 		} else {
 			// "Create a fork of ..."
 			if baseRepo.IsPrivate {
diff --git a/pkg/cmd/pr/merge/merge.go b/pkg/cmd/pr/merge/merge.go
@@ -228,7 +228,7 @@ func mergeRun(opts *MergeOptions) error {
 			}
 			if action == shared.CancelAction {
 				fmt.Fprintln(opts.IO.ErrOut, "Cancelled.")
-				return cmdutil.SilentError
+				return cmdutil.CancelError
 			}
 		}
 
diff --git a/pkg/cmd/pr/shared/preserve.go b/pkg/cmd/pr/shared/preserve.go
@@ -2,11 +2,9 @@ package shared
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
 	"os"
 
-	"github.com/AlecAivazis/survey/v2/terminal"
 	"github.com/cli/cli/pkg/cmdutil"
 	"github.com/cli/cli/pkg/iostreams"
 )
@@ -21,7 +19,7 @@ func PreserveInput(io *iostreams.IOStreams, state *IssueMetadataState, createErr
 			return
 		}
 
-		if errors.Is(*createErr, cmdutil.SilentError) || errors.Is(*createErr, terminal.InterruptErr) {
+		if cmdutil.IsUserCancellation(*createErr) {
 			// these errors are user-initiated cancellations
 			return
 		}
diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go
@@ -262,7 +262,7 @@ func createRun(opts *CreateOptions) error {
 		case "Save as draft":
 			opts.Draft = true
 		case "Cancel":
-			return cmdutil.SilentError
+			return cmdutil.CancelError
 		default:
 			return fmt.Errorf("invalid action: %v", opts.SubmitAction)
 		}
diff --git a/pkg/cmd/release/delete/delete.go b/pkg/cmd/release/delete/delete.go
@@ -78,7 +78,7 @@ func deleteRun(opts *DeleteOptions) error {
 		}
 
 		if !confirmed {
-			return cmdutil.SilentError
+			return cmdutil.CancelError
 		}
 	}
 
diff --git a/pkg/cmdutil/errors.go b/pkg/cmdutil/errors.go
@@ -1,6 +1,10 @@
 package cmdutil
 
-import "errors"
+import (
+	"errors"
+
+	"github.com/AlecAivazis/survey/v2/terminal"
+)
 
 // FlagError is the kind of error raised in flag processing
 type FlagError struct {
@@ -17,3 +21,10 @@ func (fe FlagError) Unwrap() error {
 
 // SilentError is an error that triggers exit code 1 without any error messaging
 var SilentError = errors.New("SilentError")
+
+// CancelError signals user-initiated cancellation
+var CancelError = errors.New("CancelError")
+
+func IsUserCancellation(err error) bool {
+	return errors.Is(err, CancelError) || errors.Is(err, terminal.InterruptErr)
+}

Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ func editRun(opts *EditOptions) error {`
`177`	`177`	`case "Submit":`
`178`	`178`	`stop = true`
`179`	`179`	`case "Cancel":`
`180`		`- return cmdutil.SilentError`
	`180`	`+ return cmdutil.CancelError`
`181`	`181`	`}`
`182`	`182`
`183`	`183`	`if stop {`
Original file line number	Diff line number	Diff line change
`@@ -249,7 +249,7 @@ func createRun(opts *CreateOptions) (err error) {`
`249`	`249`
`250`	`250`	`if action == prShared.CancelAction {`
`251`	`251`	`fmt.Fprintln(opts.IO.ErrOut, "Discarding.")`
`252`		`- err = cmdutil.SilentError`
	`252`	`+ err = cmdutil.CancelError`
`253`	`253`	`return`
`254`	`254`	`}`
`255`	`255`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ func mergeRun(opts *MergeOptions) error {`
`228`	`228`	`}`
`229`	`229`	`if action == shared.CancelAction {`
`230`	`230`	`fmt.Fprintln(opts.IO.ErrOut, "Cancelled.")`
`231`		`- return cmdutil.SilentError`
	`231`	`+ return cmdutil.CancelError`
`232`	`232`	`}`
`233`	`233`	`}`
`234`	`234`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,9 @@ package shared`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"encoding/json"`
`5`		`- "errors"`
`6`	`5`	`"fmt"`
`7`	`6`	`"os"`
`8`	`7`
`9`		`- "github.com/AlecAivazis/survey/v2/terminal"`
`10`	`8`	`"github.com/cli/cli/pkg/cmdutil"`
`11`	`9`	`"github.com/cli/cli/pkg/iostreams"`
`12`	`10`	`)`
`@@ -21,7 +19,7 @@ func PreserveInput(io iostreams.IOStreams, state IssueMetadataState, createErr`
`21`	`19`	`return`
`22`	`20`	`}`
`23`	`21`
`24`		`- if errors.Is(createErr, cmdutil.SilentError) \|\| errors.Is(createErr, terminal.InterruptErr) {`
	`22`	`+ if cmdutil.IsUserCancellation(*createErr) {`
`25`	`23`	`// these errors are user-initiated cancellations`
`26`	`24`	`return`
`27`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ func createRun(opts *CreateOptions) error {`
`262`	`262`	`case "Save as draft":`
`263`	`263`	`opts.Draft = true`
`264`	`264`	`case "Cancel":`
`265`		`- return cmdutil.SilentError`
	`265`	`+ return cmdutil.CancelError`
`266`	`266`	`default:`
`267`	`267`	`return fmt.Errorf("invalid action: %v", opts.SubmitAction)`
`268`	`268`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func deleteRun(opts *DeleteOptions) error {`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`if !confirmed {`
`81`		`- return cmdutil.SilentError`
	`81`	`+ return cmdutil.CancelError`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`