STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3341 from cli/actions-help-section

Browse source 
Add section in help for actions commands
This commit is contained in:
Sam 2021-04-02 08:34:35 -07:00 • committed by GitHub
commit 01b3f0f1cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

3
pkg/cmd/actions/actions.go
View file

@ -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

6
pkg/cmd/root/help.go
View file

@ -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")})
}

7
pkg/cmd/run/run.go
View file

@ -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)

7
pkg/cmd/workflow/workflow.go
View file

@ -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)