Merge pull request #6081 from inktomi/exit-codes

Document exit codes used by gh

pkg/cmd/root/help_topic.go

@@ -129,6 +129,24 @@ var HelpTopics = map[string]map[string]string{
 			  '
 		`),
 	},
+	"exit-codes": {
+		"short": "Exit codes used by gh",
+		"long": heredoc.Doc(`
+			gh follows normal conventions regarding exit codes.
+
+			- If a command completes successfully, the exit code will be 0
+			
+			- If a command fails for any reason, the exit code will be 1
+
+			- If a command is running but gets cancelled, the exit code will be 2
+
+			- If a command encounters an authentication issue, the exit code will be 4
+
+			NOTE: It is possible that a particular command may have more exit codes, so it is a good 
+			practice to check documentation for the command if you are relying on exit codes to 
+			control some behavior. 
+		`),
+	},
 }
 
 func NewHelpTopic(ios *iostreams.IOStreams, topic string) *cobra.Command {

pkg/cmd/root/root.go

@@ -111,6 +111,7 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command {
 	cmd.AddCommand(NewHelpTopic(f.IOStreams, "environment"))
 	cmd.AddCommand(NewHelpTopic(f.IOStreams, "formatting"))
 	cmd.AddCommand(NewHelpTopic(f.IOStreams, "mintty"))
+	cmd.AddCommand(NewHelpTopic(f.IOStreams, "exit-codes"))
 	referenceCmd := NewHelpTopic(f.IOStreams, "reference")
 	referenceCmd.SetHelpFunc(referenceHelpFn(f.IOStreams))
 	cmd.AddCommand(referenceCmd)