plugins

Documentation

Index

• Constants
• func AddPluginRoute(route PluginRoute) error
• func CheckForNewVersion(plugin Plugin) (string, error)
• func CreateAndAddPluginRoute(plugin Plugin, source, version string) error
• func DeletePlugin(name string) error
• func DeletePluginRoute(name string) error
• func GetPluginBinDir(name string) string
• func GetPluginDataDir(name string) string
• func GetPluginDefinitionPath(name string) string
• func GetPluginDir(name string) string
• func GetPluginExecutablePath(name string) (string, bool, error)
• func GetPluginSrcDir(name string) string
• func GetPluginVersion(name string) (*ver.Version, error)
• func GitCloneAndCheckoutVersionOrLatestVersion(cloneIntoDir, repositoryURL, checkoutVersion string) (string, error)
• func GitVersionTags(gitRepoDir string) ([]*ver.Version, error)
• func InitPaths() error
• func ParseArgs(args []string) (string, []string, bool)
• func PrintPluginUpdateInfos(newVersion string, plugin Plugin)
• func RunPluginByCommand(plugin Plugin, args []string) error
• func RunPluginByEvent(plugin Plugin, pluginInput PluginInput) error
• func SortByName(plugins []Plugin)
• func TriggerEvent(name TriggerEventName, payload interface{}) error
• type ByVersion
  • func (s ByVersion) Len() int
  • func (s ByVersion) Less(i, j int) bool
  • func (s ByVersion) Swap(i, j int)
• type ExecutableModel
• type Plugin
  • func InstallPlugin(pluginSourceURI, versionTag string) (Plugin, string, error)
  • func InstalledPluginList() ([]Plugin, error)
  • func LoadPlugin(name string) (Plugin, bool, error)
  • func LoadPlugins(eventName string) ([]Plugin, error)
  • func ParsePluginFromYML(ymlPth string) (Plugin, error)
  • func (plugin Plugin) ExecutableURL() string
  • func (plugin Plugin) String() string
• type PluginInfoModel
  • func (info PluginInfoModel) JSON() string
  • func (info PluginInfoModel) String() string
• type PluginInfos
  • func (infos PluginInfos) JSON() string
  • func (infos PluginInfos) String() string
• type PluginInput
• type PluginMode
• type PluginRoute
  • func NewPluginRoute(name, source, executable, version, triggerEvent string) (PluginRoute, error)
  • func ReadPluginRoute(name string) (PluginRoute, bool, error)
  • func (route PluginRoute) Validate() error
• type PluginRouting
  • func NewPluginRouting() PluginRouting
  • func NewPluginRoutingFromBytes(bytes []byte) (PluginRouting, error)
  • func NewPluginRoutingFromYMLOrEmpty(ymlPth string) (PluginRouting, error)
  • func (routing *PluginRouting) AddRoute(route PluginRoute)
  • func (routing *PluginRouting) DeleteRoute(routeName string)
  • func (routing PluginRouting) Validate() error
• type Requirement
• type TriggerEventName

Constants

const (
	// TypeGeneric ...
	TypeGeneric = "_"
	// TypeInit ...
	TypeInit = "init"
	// TypeRun ....
	TypeRun = "run"
)

const (
	// PluginInputPayloadKey ...
	PluginInputPayloadKey = "BITRISE_PLUGIN_INPUT_PAYLOAD"
	// PluginInputBitriseVersionKey ...
	PluginInputBitriseVersionKey = "BITRISE_PLUGIN_INPUT_BITRISE_VERSION"
	// PluginInputTriggerEventKey ...
	PluginInputTriggerEventKey = "BITRISE_PLUGIN_INPUT_TRIGGER"
	// PluginInputPluginModeKey ...
	PluginInputPluginModeKey = "BITRISE_PLUGIN_INPUT_PLUGIN_MODE"
	// PluginInputDataDirKey ...
	PluginInputDataDirKey = "BITRISE_PLUGIN_INPUT_DATA_DIR"
	// PluginInputFormatVersionKey ...
	PluginInputFormatVersionKey = "BITRISE_PLUGIN_INPUT_FORMAT_VERSION"

	// PluginOutputEnvKey ...
	PluginOutputEnvKey = "BITRISE_PLUGIN_OUTPUT"
)

Functions

func AddPluginRoute

func AddPluginRoute(route PluginRoute) error

AddPluginRoute ...

func CheckForNewVersion

func CheckForNewVersion(plugin Plugin) (string, error)

CheckForNewVersion ...

func CreateAndAddPluginRoute

func CreateAndAddPluginRoute(plugin Plugin, source, version string) error

CreateAndAddPluginRoute ...

func DeletePlugin

func DeletePlugin(name string) error

DeletePlugin ...

func DeletePluginRoute

func DeletePluginRoute(name string) error

DeletePluginRoute ...

func GetPluginBinDir

func GetPluginBinDir(name string) string

GetPluginBinDir ...

func GetPluginDataDir

func GetPluginDataDir(name string) string

GetPluginDataDir ...

func GetPluginDefinitionPath

func GetPluginDefinitionPath(name string) string

GetPluginDefinitionPath ...

func GetPluginDir

func GetPluginDir(name string) string

GetPluginDir ...

func GetPluginExecutablePath

func GetPluginExecutablePath(name string) (string, bool, error)

GetPluginExecutablePath ...

func GetPluginSrcDir

func GetPluginSrcDir(name string) string

GetPluginSrcDir ...

func GetPluginVersion

func GetPluginVersion(name string) (*ver.Version, error)

GetPluginVersion ...

func GitCloneAndCheckoutVersionOrLatestVersion

func GitCloneAndCheckoutVersionOrLatestVersion(cloneIntoDir, repositoryURL, checkoutVersion string) (string, error)

GitCloneAndCheckoutVersionOrLatestVersion ...

func GitVersionTags

func GitVersionTags(gitRepoDir string) ([]*ver.Version, error)

GitVersionTags ...

func InitPaths

func InitPaths() error

InitPaths ...

func ParseArgs

func ParseArgs(args []string) (string, []string, bool)

ParseArgs ...

func PrintPluginUpdateInfos

func PrintPluginUpdateInfos(newVersion string, plugin Plugin)

PrintPluginUpdateInfos ...

func RunPluginByCommand

func RunPluginByCommand(plugin Plugin, args []string) error

RunPluginByCommand ...

func RunPluginByEvent

func RunPluginByEvent(plugin Plugin, pluginInput PluginInput) error

RunPluginByEvent ...

func SortByName

func SortByName(plugins []Plugin)

SortByName ...

func TriggerEvent

func TriggerEvent(name TriggerEventName, payload interface{}) error

TriggerEvent ...

Types

type ByVersion

type ByVersion []*ver.Version

ByVersion ..

func (ByVersion) Len

func (s ByVersion) Len() int

func (ByVersion) Less

func (s ByVersion) Less(i, j int) bool

func (ByVersion) Swap

func (s ByVersion) Swap(i, j int)

type ExecutableModel

type ExecutableModel struct {
	OSX   string `yaml:"osx,omitempty"`
	Linux string `yaml:"linux,omitempty"`
}

ExecutableModel ...

type Plugin

type Plugin struct {
	Name         string          `yaml:"name,omitempty"`
	Description  string          `yaml:"description,omitempty"`
	Executable   ExecutableModel `yaml:"executable,omitempty"`
	TriggerEvent string          `yaml:"trigger,omitempty"`
	Requirements []Requirement   `yaml:"requirements,omitempty"`
}

Plugin ...

func InstallPlugin

func InstallPlugin(pluginSourceURI, versionTag string) (Plugin, string, error)

InstallPlugin ...

func InstalledPluginList

func InstalledPluginList() ([]Plugin, error)

InstalledPluginList ...

func LoadPlugin

func LoadPlugin(name string) (Plugin, bool, error)

LoadPlugin ...

func LoadPlugins

func LoadPlugins(eventName string) ([]Plugin, error)

LoadPlugins ...

func ParsePluginFromYML

func ParsePluginFromYML(ymlPth string) (Plugin, error)

ParsePluginFromYML ...

func (Plugin) ExecutableURL

func (plugin Plugin) ExecutableURL() string

ExecutableURL ...

func (Plugin) String

func (plugin Plugin) String() string

type PluginInfoModel

type PluginInfoModel struct {
	Name          string `json:"name,omitempty"`
	Version       string `json:"version,omitempty"`
	Source        string `json:"source,omitempty"`
	Plugin        Plugin `json:"plugin,omitempty"`
	DefinitionPth string `json:"definition_pth,omitempty"`
}

PluginInfoModel ...

func (PluginInfoModel) JSON

func (info PluginInfoModel) JSON() string

JSON ...

func (PluginInfoModel) String

func (info PluginInfoModel) String() string

String ...

type PluginInfos

type PluginInfos []PluginInfoModel

PluginInfos ...

func (PluginInfos) JSON

func (infos PluginInfos) JSON() string

JSON ...

func (PluginInfos) String

func (infos PluginInfos) String() string

String ...

type PluginInput

type PluginInput map[string]string

PluginInput ...

type PluginMode

type PluginMode string

PluginMode ...

const (
	// TriggerMode ...
	TriggerMode PluginMode = "trigger"
	// CommandMode ...
	CommandMode PluginMode = "command"
)

type PluginRoute

type PluginRoute struct {
	Name                   string `yaml:"name"`
	Source                 string `yaml:"source"`
	Version                string `yaml:"version"`
	CommitHash             string `yaml:"commit_hash"`
	Executable             string `yaml:"executable"`
	TriggerEvent           string `yaml:"trigger"`
	LatestAvailableVersion string `yaml:"latest_available_version"`
}

PluginRoute ...

func NewPluginRoute

func NewPluginRoute(name, source, executable, version, triggerEvent string) (PluginRoute, error)

NewPluginRoute ...

func ReadPluginRoute

func ReadPluginRoute(name string) (PluginRoute, bool, error)

ReadPluginRoute ...

func (PluginRoute) Validate

func (route PluginRoute) Validate() error

Validate ...

type PluginRouting

type PluginRouting struct {
	RouteMap map[string]PluginRoute `yaml:"route_map"`
}

PluginRouting ...

func NewPluginRouting

func NewPluginRouting() PluginRouting

NewPluginRouting ...

func NewPluginRoutingFromBytes

func NewPluginRoutingFromBytes(bytes []byte) (PluginRouting, error)

NewPluginRoutingFromBytes ...

func NewPluginRoutingFromYMLOrEmpty

func NewPluginRoutingFromYMLOrEmpty(ymlPth string) (PluginRouting, error)

NewPluginRoutingFromYMLOrEmpty ...

func (*PluginRouting) AddRoute

func (routing *PluginRouting) AddRoute(route PluginRoute)

AddRoute ...

func (*PluginRouting) DeleteRoute

func (routing *PluginRouting) DeleteRoute(routeName string)

DeleteRoute ...

func (PluginRouting) Validate

func (routing PluginRouting) Validate() error

Validate ...

type Requirement

type Requirement struct {
	Tool       string `yaml:"tool"`
	MinVersion string `yaml:"min_version"`
	MaxVersion string `yaml:"max_version"`
}

Requirement ...

type TriggerEventName

type TriggerEventName string

TriggerEventName ...

const (
	// DidFinishRun ...
	DidFinishRun TriggerEventName = "DidFinishRun"
)