step

package
v0.38.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2025 License: MIT Imports: 2 Imported by: 10

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuxConfig

type AuxConfig any

AuxConfig is the unmarshalled additional config, (not useful, only to make typing clearer).

type AuxConfigRaw

type AuxConfigRaw struct {
	Unmarshal func(any) error `yaml:"-"`
}

func (*AuxConfigRaw) UnmarshalYAML

func (s *AuxConfigRaw) UnmarshalYAML(unmarshal func(any) error) error

type Config

type Config struct {
	Index Index `yaml:"-"`

	// Include this step given conditions.
	Include Include `yaml:"include"`

	// The runner with this name and stage name from the target will be used.
	Runner string `yaml:"runner"`
	// The runner given by this id which will used.
	RunnerID string `yaml:"runnerID"`

	// The toolchain to use for the runner can be overridden.
	Toolchain string `yaml:"toolchain"`

	// The (optional) raw runner config, before unmarshalling.
	ConfigRaw AuxConfigRaw `yaml:"config,omitempty"`
}

Config is the the runner config.

func (*Config) Init

func (c *Config) Init(idx Index) (err error)

type Include added in v0.28.0

type Include struct {
	// The tag expression associated with this step.
	// This is useful to include/exclude this step given certain tags.
	// This expression is parsed as a Go build line `//go:build <tagInclude>.
	// If the expression matches against given tags, then this step is included.
	// If there is no expression (default) its included.
	TagExpr tags.Expr `yaml:"tagExpr"`
}

type Index

type Index int

type RunnerConfigUnmarshaller

type RunnerConfigUnmarshaller func(raw AuxConfigRaw) (AuxConfig, error)

RunnerConfigUnmarshaller is the interface registered in the runner factory to unmarshal configs for the runner.

Jump to

Keyboard shortcuts

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