plugin

Documentation

Index

• Variables
• func Flags(settings *Settings, category string) []cli.Flag
• func WriteNetrc(path, machine, login, password string) error
• type Netrc
• type Plugin
  • func New(e plugin_base.ExecuteFunc, build ...string) *Plugin
  • func (p *Plugin) Execute(ctx context.Context) error
  • func (p *Plugin) FlagsFromContext() error
  • func (p *Plugin) Validate() error
• type Settings

Variables

var (
	ErrGitCloneDestintionNotValid = errors.New("destination not valid")
	ErrTypeAssertionFailed        = errors.New("type assertion failed")
)

Functions

func Flags

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

Flags returns a slice of CLI flags for the plugin.

func WriteNetrc

func WriteNetrc(path, machine, login, password string) error

WriteNetrc writes the netrc file.

Types

type Netrc

type Netrc struct {
	Machine  string
	Login    string
	Password string
}

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(ctx context.Context) error

Execute provides the implementation of the plugin.

func (*Plugin) FlagsFromContext

func (p *Plugin) FlagsFromContext() error

func (*Plugin) Validate

func (p *Plugin) Validate() error

Validate handles the settings validation of the plugin.

type Settings

type Settings struct {
	Recursive bool
	Tags      bool
	Lfs       bool
	Partial   bool
	Home      string
	SSHKey    string

	Netrc Netrc
	Repo  git.Repository
}

Settings for the plugin.