velox

README

Compatibility with the plugins:

1. ⚠️ Do not use plugin's master branch.
2. ⚠️ Use tags with the same major version (e.g logger v3.0.3 + amqp v3.0.5, but not logger v4.0.0 + amqp v3.0.5)
3. ⚠️ Currently supported plugins version is: v5.x.x
4. ⚠️ Currently supported RR version is: >=v2024.x.x

Docs: link

Documentation

Index

• Constants
• func IsDigit(num string) bool
• func ParseModuleInfo(module string, t time.Time, rev string) string
• type CodeHosting
• type Config
  • func (c *Config) Validate() error
• type Debug
• type Endpoint
• type ModulesInfo
• type PluginConfig
• type Token

Constants

const (
	V2024 string = "v2024"
	V2023 string = "v2023"
	V2    string = "v2"
)

Functions

func IsDigit

func IsDigit(num string) bool

func ParseModuleInfo

func ParseModuleInfo(module string, t time.Time, rev string) string

ParseModuleInfo here we accept a module name and return the version e.g.: github.com/roadrunner-server/logger/v2 => v2

Types

type CodeHosting

type CodeHosting struct {
	BaseURL *Endpoint                `mapstructure:"endpoint"`
	Token   *Token                   `mapstructure:"token"`
	Plugins map[string]*PluginConfig `mapstructure:"plugins"`
}

type Config

type Config struct {
	// Version
	Roadrunner map[string]string `mapstructure:"roadrunner"`
	// Debug configuration
	Debug *Debug `mapstructure:"debug"`
	// GitHub configuration
	GitHub *CodeHosting `mapstructure:"github"`
	// GitLab configuration
	GitLab *CodeHosting `mapstructure:"gitlab"`
	// Log contains log configuration
	Log map[string]string `mapstructure:"log"`
}

func (*Config) Validate

func (c *Config) Validate() error

type Debug

type Debug struct {
	Enabled bool `mapstructure:"enabled"`
}

type Endpoint

type Endpoint struct {
	BaseURL string `mapstructure:"endpoint"`
}

type ModulesInfo

type ModulesInfo struct {
	// Version - commit sha or tag
	Version string
	// PseudoVersion - Go pseudo version
	PseudoVersion string
	// module name - eg: github.com/roadrunner-server/logger/v2
	ModuleName string
	// Replace (for the local dev)
	Replace string
}

ModulesInfo represents single go module

type PluginConfig

type PluginConfig struct {
	Ref     string `mapstructure:"ref"`
	Owner   string `mapstructure:"owner"`
	Repo    string `mapstructure:"repository"`
	Folder  string `mapstructure:"folder"`
	Replace string `mapstructure:"replace"`
}

type Token

type Token struct {
	Token string `mapstructure:"token"`
}