plugin

Documentation

Index

• Variables
• func Flags(settings *Settings, category string) []cli.Flag
• type Plugin
  • func New(e plugin_base.ExecuteFunc, build ...string) *Plugin
  • func (p *Plugin) Execute() error
  • func (p *Plugin) Validate() error
• type Settings

Variables

var ErrPluginEventNotSupported = errors.New("event not supported")

Functions

func Flags

func Flags(settings *Settings, category string) []cli.Flag

Flags returns a slice of CLI flags for the plugin.

Types

type Plugin

type Plugin struct {
	*plugin_base.Plugin
	Settings *Settings
}

Plugin implements provide the plugin.

func New

func New(e plugin_base.ExecuteFunc, build ...string) *Plugin

func (*Plugin) Execute

func (p *Plugin) Execute() error

Execute provides the implementation of the plugin.

func (*Plugin) Validate

func (p *Plugin) Validate() error

Validate handles the settings validation of the plugin.

type Settings

type Settings struct {
	BaseURL     string
	IssueNum    int
	Key         string
	Message     string
	Update      bool
	APIKey      string
	SkipMissing bool
	IsFile      bool
	// contains filtered or unexported fields
}

Settings for the Plugin.