velox

package module

v2025.1.7 Latest Latest Go to latest Published: Feb 17, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/roadrunner-server/velox

Links

Open Source Insights

README ¶

Compatibility with the plugins:

⚠️ Do not use plugin's master branch.
⚠️ 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)
⚠️ Currently supported plugins version is: v5.x.x
⚠️ Currently supported RR version is: >=v2024.x.x

Docs: link

Documentation ¶

Overview ¶

Package velox defines configuration types and validation used by Velox builds.

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 ¶

View Source

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

Variables ¶

This section is empty.

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"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
builder Package builder builds RoadRunner binaries with selected plugins and target platform options.	Package builder builds RoadRunner binaries with selected plugins and target platform options.
templates Package templates provides template data structures and compilers for generated RoadRunner sources.	Package templates provides template data structures and compilers for generated RoadRunner sources.
cmd
vx command Package main provides the vx CLI entrypoint.	Package main provides the vx CLI entrypoint.
github Package github provides a client for downloading and extracting RoadRunner templates from GitHub.	Package github provides a client for downloading and extracting RoadRunner templates from GitHub.
gitlab Package gitlab provides a client for reading plugin module metadata from GitLab repositories.	Package gitlab provides a client for reading plugin module metadata from GitLab repositories.
internal
cli Package cli wires the root cobra command and shared CLI setup.	Package cli wires the root cobra command and shared CLI setup.
cli/build Package build provides the CLI command that builds RoadRunner from Velox config.	Package build provides the CLI command that builds RoadRunner from Velox config.
version Package version exposes build-time version and timestamp helpers.	Package version exposes build-time version and timestamp helpers.
logger Package logger builds zap loggers and custom encoders used by Velox.	Package logger builds zap loggers and custom encoders used by Velox.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL