prow

Documentation

Index

• func GenPluginHelpMarkdown(name string, help PluginHelp) string
• type AllPluginHelp
  • func GetDoc(url string) (*AllPluginHelp, error)
• type Command
• type PluginHelp

Functions

func GenPluginHelpMarkdown

func GenPluginHelpMarkdown(name string, help PluginHelp) string

Types

type AllPluginHelp

type AllPluginHelp struct {
	PluginHelp         map[string]PluginHelp
	ExternalPluginHelp map[string]PluginHelp
}

func GetDoc

func GetDoc(url string) (*AllPluginHelp, error)

type Command

type Command struct {
	Usage       string
	Featured    bool
	Description string
	Examples    []string
	WhoCanUse   string
}

type PluginHelp

type PluginHelp struct {
	Description string
	Config      map[string]string
	Snippet     string
	Events      []string
	Commands    []Command
}