Versions in this module Expand all Collapse all v0 v0.6.0 May 12, 2026 Changes in this version type ExecutionContext + CurrentMode actions.Mode v0.5.0 May 12, 2026 Changes in this version + const ModeExecute + const ModePlan + func AddGlobalVariables(variables map[string]interface{}) + func CheckIdempotencyConditions(step config.Step, ec *ExecutionContext) (bool, string, error) + func CheckSkipConditions(step config.Step, ec *ExecutionContext) (bool, string, error) + func DispatchStepAction(step config.Step, ec *ExecutionContext) error + func ExecutePlan(p *plan.Plan, sudoPass string, dryRun bool, checkMode bool, log logger.Logger, ...) error + func GetStepDisplayName(step config.Step, ec *ExecutionContext) (string, bool) + func HandleVars(step config.Step, ec *ExecutionContext) error + func HandleWhenExpression(step config.Step, ec *ExecutionContext) (bool, error) + func InspectPlan(p *plan.Plan, sudoPass string, log logger.Logger) ([]plan.StepInspection, error) + func MarkStepFailed(result *Result, step config.Step, ec *ExecutionContext) + func ParseFileMode(modeStr string, defaultMode os.FileMode) os.FileMode + func ShouldSkipByTags(step config.Step, ec *ExecutionContext) bool + type AssertionError struct + Actual string + Cause error + Details string + Expected string + Type string + func (e *AssertionError) Error() string + func (e *AssertionError) Unwrap() error + type CommandError struct + Cause error + Duration string + ExitCode int + Timeout bool + func (e *CommandError) Error() string + func (e *CommandError) Unwrap() error + type DryRunLogger struct + func NewDryRunLogger(log logger.Logger) *DryRunLogger + func (d *DryRunLogger) LogArchiveExtraction(src, dest, format string, stripComponents int) + func (d *DryRunLogger) LogAssertCheck(assertType, expected string) + func (d *DryRunLogger) LogDirectoryCreate(path string, mode os.FileMode) + func (d *DryRunLogger) LogDirectoryRemove(path string) + func (d *DryRunLogger) LogFileCopy(src, dest string, mode os.FileMode, size int64) + func (d *DryRunLogger) LogFileCopyNoChange(src, dest string) + func (d *DryRunLogger) LogFileCreate(path string, mode os.FileMode, size int) + func (d *DryRunLogger) LogFileDownload(url, dest string, mode os.FileMode) + func (d *DryRunLogger) LogFileDownloadNoChange(_, dest string) + func (d *DryRunLogger) LogFileRemove(path string, size int64) + func (d *DryRunLogger) LogFileTouch(path string) + func (d *DryRunLogger) LogFileUpdate(path string, mode os.FileMode, oldSize, newSize int) + func (d *DryRunLogger) LogHardlinkCreate(src, dest string, force bool) + func (d *DryRunLogger) LogHardlinkNoChange(src, dest string) + func (d *DryRunLogger) LogPermissionsChange(path, mode, owner, group string, recurse bool) + func (d *DryRunLogger) LogPermissionsNoChange(path string) + func (d *DryRunLogger) LogPresetOperation(invocation *config.PresetInvocation, paramsCount int) + func (d *DryRunLogger) LogPrintMessage(message string) + func (d *DryRunLogger) LogRegister(step config.Step) + func (d *DryRunLogger) LogServiceOperation(serviceName string, serviceAction *config.ServiceAction, withSudo bool) + func (d *DryRunLogger) LogShellExecution(command string, withSudo bool) + func (d *DryRunLogger) LogSymlinkCreate(src, dest string, force bool) + func (d *DryRunLogger) LogSymlinkNoChange(src, dest string) + func (d *DryRunLogger) LogTemplateCreate(src, dest string, mode os.FileMode, size int) + func (d *DryRunLogger) LogTemplateNoChange(src, dest string) + func (d *DryRunLogger) LogTemplateRender(src, dest string, mode os.FileMode) + func (d *DryRunLogger) LogTemplateUpdate(src, dest string, mode os.FileMode, oldSize, newSize int) + func (d *DryRunLogger) LogVariableLoad(count int, source string) + func (d *DryRunLogger) LogVariableSet(count int) + type EvaluationError struct + Cause error + Expression string + func (e *EvaluationError) Error() string + func (e *EvaluationError) Unwrap() error type ExecutionContext + CheckMode bool + CurrentResult *Result + CurrentStepID string + EventPublisher events.Publisher + PresetBaseDir string + Redactor *security.Redactor + Stats *ExecutionStats + func (ec *ExecutionContext) Clone() ExecutionContext + func (ec *ExecutionContext) Effects() actions.Performer + func (ec *ExecutionContext) EmitEvent(eventType events.EventType, data interface{}) + func (ec *ExecutionContext) GetCurrentStepID() string + func (ec *ExecutionContext) GetEvaluator() expression.Evaluator + func (ec *ExecutionContext) GetEventPublisher() events.Publisher + func (ec *ExecutionContext) GetLogger() logger.Logger + func (ec *ExecutionContext) GetTemplate() template.Renderer + func (ec *ExecutionContext) GetVariables() map[string]interface{} + func (ec *ExecutionContext) HandleDryRun(logFn func(*DryRunLogger)) bool + func (ec *ExecutionContext) IsDryRun() bool + func (ec *ExecutionContext) Mode() Mode + type ExecutionStats struct + Changed *int + Executed *int + Failed *int + Global *int + Skipped *int + func NewExecutionStats() *ExecutionStats + type FileOperationError struct + Cause error + Operation string + Path string + func (e *FileOperationError) Error() string + func (e *FileOperationError) Unwrap() error + type Mode = actions.Mode + type RenderError struct + Cause error + Field string + func (e *RenderError) Error() string + func (e *RenderError) Unwrap() error + type Result struct + Changed bool + Checkable bool + Data map[string]interface{} + Duration time.Duration + EndTime time.Time + Failed bool + Rc int + Reason string + Skipped bool + StartTime time.Time + Stderr string + Stdout string + WouldChange bool + func NewResult() *Result + func (r *Result) RegisterTo(variables map[string]interface{}, name string) + func (r *Result) SetChanged(changed bool) + func (r *Result) SetData(data map[string]interface{}) + func (r *Result) SetFailed(failed bool) + func (r *Result) SetStderr(stderr string) + func (r *Result) SetStdout(stdout string) + func (r *Result) Status() string + func (r *Result) ToMap() map[string]interface{} + type SetupError struct + Cause error + Component string + Issue string + func (e *SetupError) Error() string + func (e *SetupError) Unwrap() error type StartConfig + ArtifactsDir string + AskBecomePass bool + CaptureFullOutput bool + CheckMode bool + InsecureSudoPass bool + MaxOutputBytes int + MaxOutputLines int + SudoPassFile string + type StepValidationError struct + Field string + Message string + func (e *StepValidationError) Error() string v0.2.0 Jan 30, 2026 Changes in this version + func ExecuteStep(step config.Step, ec *ExecutionContext) error + func ExecuteSteps(steps []config.Step, ec *ExecutionContext) error + func HandleFile(step config.Step, ec *ExecutionContext) error + func HandleIncludeVars(step config.Step, ec *ExecutionContext) error + func HandleShell(step config.Step, ec *ExecutionContext) error + func HandleTemplate(step config.Step, ec *ExecutionContext) error + func HandleWithFileTree(step config.Step, ec *ExecutionContext) error + func HandleWithItems(step config.Step, ec *ExecutionContext) error + func Start(startConfig StartConfig, log logger.Logger) error + type ExecutionContext struct + CurrentDir string + CurrentFile string + CurrentIndex int + DryRun bool + Evaluator expression.Evaluator + FileTree *filetree.Walker + Level int + Logger logger.Logger + PathUtil *pathutil.PathExpander + SudoPass string + Tags []string + Template template.Renderer + TotalSteps int + Variables map[string]interface{} + func (ec *ExecutionContext) Copy() ExecutionContext + type StartConfig struct + ConfigFilePath string + DryRun bool + SudoPass string + Tags []string + VarsFilePath string
Go to main page