runner

package

Go to main page

Versions in this module

v0

v0.5.0

Feb 14, 2025

Changes in this version

+ type OCIStepResource struct

+ func NewOCIStepResource(url string, tag string, path []string, filename string) *OCIStepResource

+ func (sr *OCIStepResource) Describe() string

+ func (sr *OCIStepResource) Interpolate(_ *expression.InterpolationContext) (StepResource, error)

+ func (sr *OCIStepResource) ToProtoStepRef() *proto.Step_Reference

v0.4.0

Jan 31, 2025

v0.3.0

Jan 10, 2025

v0.2.1

Dec 13, 2024

v0.2.0

Dec 6, 2024

Changes in this version

+ var RunningInDebugMode = strconv.ParseBool(os.Getenv("CI_STEPS_DEBUG"))

+ func WithErrCtxLogAdditionalCtx(logAdditionalCtx bool) func(*ErrorCtx)

+ type ErrorCtx struct

+ func NewErrorCtx(description string, additionalCxt []byte, options ...func(*ErrorCtx)) *ErrorCtx

+ func (e *ErrorCtx) Errorf(message string, v ...any) error

type GlobalContext

+ func (gc *GlobalContext) Logf(format string, v ...any) error

+ func (gc *GlobalContext) Logln(format string, v ...any) error

type NamedStepReference

+ func (sr *NamedStepReference) Describe() string

+ type StepFileLine struct

+ Name *string

+ Value *structpb.Value

v0.1.0

Nov 19, 2024

Changes in this version

+ var StepDefinedInGitLabJob = NewNamedStepReference("", nil)

+ type Cache interface

+ Get func(ctx context.Context, parentDir string, stepResource StepResource) (*proto.SpecDefinition, error)

+ type Describer interface

+ Describe func() string

+ type Environment struct

+ func NewEmptyEnvironment() *Environment

+ func NewEnvironment(vars map[string]string) *Environment

+ func NewEnvironmentFromOS(names ...string) (*Environment, error)

+ func NewEnvironmentFromOSWithKnownVars() (*Environment, error)

+ func NewKVEnvironment(keyValues ...string) *Environment

+ func (e *Environment) AddLexicalScope(vars map[string]string) *Environment

+ func (e *Environment) Len() int

+ func (e *Environment) Mutate(env *Environment)

+ func (e *Environment) ValueOf(key string) string

+ func (e *Environment) Values() map[string]string

+ type ExecResult struct

+ func NewExecResult(workDir string, cmdArgs []string, exitCode int) *ExecResult

+ func (ec *ExecResult) ToProto() *proto.StepResult_ExecResult

+ type ExecutableStep struct

+ func NewExecutableStep(loadedFrom StepReference, params *Params, specDef *proto.SpecDefinition) *ExecutableStep

+ func (s *ExecutableStep) Describe() string

+ func (s *ExecutableStep) Run(ctx ctx.Context, stepsCtx *StepsContext) (*proto.StepResult, error)

+ type FileSystemStepResource struct

+ func NewFileSystemStepResource(path []string, filename string) *FileSystemStepResource

+ func (sr *FileSystemStepResource) Describe() string

+ func (sr *FileSystemStepResource) Interpolate(_ *expression.InterpolationContext) (StepResource, error)

+ func (sr *FileSystemStepResource) ToProtoStepRef() *proto.Step_Reference

+ type GitStepResource struct

+ func NewGitStepResource(url string, version string, path []string, filename string) *GitStepResource

+ func (sr *GitStepResource) Describe() string

+ func (sr *GitStepResource) Interpolate(view *expression.InterpolationContext) (StepResource, error)

+ func (sr *GitStepResource) ToProtoStepRef() *proto.Step_Reference

+ type GlobalContext struct

+ Env *Environment

+ Job map[string]string

+ Stderr io.Writer

+ Stdout io.Writer

+ WorkDir string

+ func NewGlobalContext(env *Environment) *GlobalContext

+ type LazilyLoadedStep struct

+ func NewLazilyLoadedStep(globalCtx *GlobalContext, resourceLoader Cache, parser StepParser, ...) *LazilyLoadedStep

+ func (s *LazilyLoadedStep) Describe() string

+ func (s *LazilyLoadedStep) Run(ctx ctx.Context, parentStepsCtx *StepsContext) (*proto.StepResult, error)

+ type NamedStepReference struct

+ func NewNamedStepReference(name string, ref *proto.Step_Reference) *NamedStepReference

+ func (sr *NamedStepReference) ToProtoStep(params *Params) *proto.Step

+ type Params struct

+ Env map[string]string

+ Inputs map[string]*context.Variable

+ func (p *Params) NewInputsWithDefault(specInputs map[string]*proto.Spec_Content_Input) map[string]*structpb.Value

+ type Parser struct

+ func NewParser(globalCtx *GlobalContext, stepCache Cache) *Parser

+ func (p *Parser) Parse(specDef *proto.SpecDefinition, params *Params, loadedFrom StepReference) (Step, error)

+ type SequenceOfSteps struct

+ func NewSequenceOfSteps(loadedFrom StepReference, params *Params, specDef *proto.SpecDefinition, ...) *SequenceOfSteps

+ func (s *SequenceOfSteps) Describe() string

+ func (s *SequenceOfSteps) Run(ctx ctx.Context, stepsCtx *StepsContext) (*proto.StepResult, error)

+ type Step interface

+ Run func(ctx ctx.Context, stepsCtx *StepsContext) (*proto.StepResult, error)

+ type StepFile struct

+ func NewStepFile(path string) *StepFile

+ func NewStepFileInDir(dir string) (*StepFile, error)

+ func NewStepFileInTmp() (*StepFile, error)

+ func (s *StepFile) Path() string

+ func (s *StepFile) ReadDotEnv() (map[string]string, error)

+ func (s *StepFile) ReadEnvironment() (*Environment, error)

+ func (s *StepFile) ReadKeyValueLines() (map[string]string, error)

+ func (s *StepFile) ReadStepResult() (*proto.StepResult, error)

+ func (s *StepFile) ReadValues(specOutputs map[string]*proto.Spec_Content_Output) (map[string]*structpb.Value, error)

+ func (s *StepFile) Remove() error

+ type StepParser interface

+ Parse func(specDef *proto.SpecDefinition, params *Params, loadedFrom StepReference) (Step, error)

+ type StepReference interface

+ ToProtoStep func(*Params) *proto.Step

+ type StepResource interface

+ Interpolate func(*expression.InterpolationContext) (StepResource, error)

+ ToProtoStepRef func() *proto.Step_Reference

+ type StepResultBuilder struct

+ func NewStepResultBuilder(loadedFrom StepReference, params *Params, specDef *proto.SpecDefinition) *StepResultBuilder

+ func (bldr *StepResultBuilder) Build() *proto.StepResult

+ func (bldr *StepResultBuilder) BuildFailure() *proto.StepResult

+ func (bldr *StepResultBuilder) ObserveEnv(env *Environment, err error) error

+ func (bldr *StepResultBuilder) ObserveExecutedCmd(execResult *ExecResult, err error) error

+ func (bldr *StepResultBuilder) ObserveExports(exports *Environment, err error) (*Environment, error)

+ func (bldr *StepResultBuilder) ObserveOutputs(outputs map[string]*structpb.Value, err error) error

+ func (bldr *StepResultBuilder) ObserveStepResult(stepResult *proto.StepResult, err error) (*proto.StepResult, error)

+ func (bldr *StepResultBuilder) WithEnv(env map[string]string) *StepResultBuilder

+ func (bldr *StepResultBuilder) WithExecResult(executedCmd *ExecResult) *StepResultBuilder

+ func (bldr *StepResultBuilder) WithExports(exports *Environment) *StepResultBuilder

+ func (bldr *StepResultBuilder) WithOutputs(outputs map[string]*structpb.Value) *StepResultBuilder

+ func (bldr *StepResultBuilder) WithSubStepResult(result *proto.StepResult) *StepResultBuilder

+ type StepsContext struct

+ Env *Environment

+ ExportFile *StepFile

+ Inputs map[string]*structpb.Value

+ OutputFile *StepFile

+ StepDir string

+ Steps map[string]*proto.StepResult

+ func NewStepsContext(globalCtx *GlobalContext, dir string, inputs map[string]*structpb.Value, ...) (*StepsContext, error)

+ func (s *StepsContext) Cleanup()

+ func (s *StepsContext) ExpandAndApplyEnv(env map[string]string) (*Environment, error)

+ func (s *StepsContext) GetEnvList() []string

+ func (s *StepsContext) GetEnvs() map[string]string

+ func (s *StepsContext) RecordResult(stepResult *proto.StepResult)

+ func (s *StepsContext) StepResults() []*proto.StepResult

+ func (s *StepsContext) View() *expression.InterpolationContext

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