Add section in help for actions commands

samcoe · samcoe · commit 8b1ed281215c · 2021-04-01T21:05:50.000-07:00
diff --git a/pkg/cmd/actions/actions.go b/pkg/cmd/actions/actions.go
@@ -26,6 +26,9 @@ func NewCmdActions(f *cmdutil.Factory) *cobra.Command {
 		Run: func(cmd *cobra.Command, args []string) {
 			actionsRun(opts)
 		},
+		Annotations: map[string]string{
+			"IsActions": "true",
+		},
 	}
 
 	return cmd
diff --git a/pkg/cmd/root/help.go b/pkg/cmd/root/help.go
@@ -88,6 +88,7 @@ func rootHelpFunc(cs *iostreams.ColorScheme, command *cobra.Command, args []stri
 	}
 
 	coreCommands := []string{}
+	actionsCommands := []string{}
 	additionalCommands := []string{}
 	for _, c := range command.Commands() {
 		if c.Short == "" {
@@ -100,6 +101,8 @@ func rootHelpFunc(cs *iostreams.ColorScheme, command *cobra.Command, args []stri
 		s := rpad(c.Name()+":", c.NamePadding()) + c.Short
 		if _, ok := c.Annotations["IsCore"]; ok {
 			coreCommands = append(coreCommands, s)
+		} else if _, ok := c.Annotations["IsActions"]; ok {
+			actionsCommands = append(actionsCommands, s)
 		} else {
 			additionalCommands = append(additionalCommands, s)
 		}
@@ -126,6 +129,9 @@ func rootHelpFunc(cs *iostreams.ColorScheme, command *cobra.Command, args []stri
 	if len(coreCommands) > 0 {
 		helpEntries = append(helpEntries, helpEntry{"CORE COMMANDS", strings.Join(coreCommands, "\n")})
 	}
+	if len(actionsCommands) > 0 {
+		helpEntries = append(helpEntries, helpEntry{"ACTIONS COMMANDS", strings.Join(actionsCommands, "\n")})
+	}
 	if len(additionalCommands) > 0 {
 		helpEntries = append(helpEntries, helpEntry{"ADDITIONAL COMMANDS", strings.Join(additionalCommands, "\n")})
 	}
diff --git a/pkg/cmd/run/run.go b/pkg/cmd/run/run.go
@@ -11,10 +11,11 @@ func NewCmdRun(f *cmdutil.Factory) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:    "run <command>",
 		Short:  "View details about workflow runs",
-		Hidden: true,
 		Long:   "List, view, and watch recent workflow runs from GitHub Actions.",
-		// TODO i'd like to have all the actions commands sorted into their own zone which i think will
-		// require a new annotation
+		Hidden: true,
+		Annotations: map[string]string{
+			"IsActions": "true",
+		},
 	}
 	cmdutil.EnableRepoOverride(cmd, f)
 
diff --git a/pkg/cmd/workflow/workflow.go b/pkg/cmd/workflow/workflow.go
@@ -12,10 +12,11 @@ func NewCmdWorkflow(f *cmdutil.Factory) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:    "workflow <command>",
 		Short:  "View details about GitHub Actions workflows",
-		Hidden: true,
 		Long:   "List, view, and run workflows in GitHub Actions.",
-		// TODO i'd like to have all the actions commands sorted into their own zone which i think will
-		// require a new annotation
+		Hidden: true,
+		Annotations: map[string]string{
+			"IsActions": "true",
+		},
 	}
 	cmdutil.EnableRepoOverride(cmd, f)
 

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ func NewCmdActions(f cmdutil.Factory) cobra.Command {`
`26`	`26`	`Run: func(cmd *cobra.Command, args []string) {`
`27`	`27`	`actionsRun(opts)`
`28`	`28`	`},`
	`29`	`+ Annotations: map[string]string{`
	`30`	`+ "IsActions": "true",`
	`31`	`+ },`
`29`	`32`	`}`
`30`	`33`
`31`	`34`	`return cmd`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,7 @@ func rootHelpFunc(cs iostreams.ColorScheme, command cobra.Command, args []stri`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`coreCommands := []string{}`
	`91`	`+ actionsCommands := []string{}`
`91`	`92`	`additionalCommands := []string{}`
`92`	`93`	`for _, c := range command.Commands() {`
`93`	`94`	`if c.Short == "" {`
`@@ -100,6 +101,8 @@ func rootHelpFunc(cs iostreams.ColorScheme, command cobra.Command, args []stri`
`100`	`101`	`s := rpad(c.Name()+":", c.NamePadding()) + c.Short`
`101`	`102`	`if _, ok := c.Annotations["IsCore"]; ok {`
`102`	`103`	`coreCommands = append(coreCommands, s)`
	`104`	`+ } else if _, ok := c.Annotations["IsActions"]; ok {`
	`105`	`+ actionsCommands = append(actionsCommands, s)`
`103`	`106`	`} else {`
`104`	`107`	`additionalCommands = append(additionalCommands, s)`
`105`	`108`	`}`
`@@ -126,6 +129,9 @@ func rootHelpFunc(cs iostreams.ColorScheme, command cobra.Command, args []stri`
`126`	`129`	`if len(coreCommands) > 0 {`
`127`	`130`	`helpEntries = append(helpEntries, helpEntry{"CORE COMMANDS", strings.Join(coreCommands, "\n")})`
`128`	`131`	`}`
	`132`	`+ if len(actionsCommands) > 0 {`
	`133`	`+ helpEntries = append(helpEntries, helpEntry{"ACTIONS COMMANDS", strings.Join(actionsCommands, "\n")})`
	`134`	`+ }`
`129`	`135`	`if len(additionalCommands) > 0 {`
`130`	`136`	`helpEntries = append(helpEntries, helpEntry{"ADDITIONAL COMMANDS", strings.Join(additionalCommands, "\n")})`
`131`	`137`	`}`