package
0.0.0-20240301095927-d2e7f1381995
Repository: https://github.com/cloud66-oss/trackman.git
Documentation: pkg.go.dev
# Functions
CloseAllFiles closes all files in fileRegister.
DefaultLogDefinition returns a LogDefintion based on the given base if the base is nil it creates a new one if not nil, it fills the empty values with the defaults.
ExpandEnvVars replaces any reference to environment variables with the OS envs.
LoadWorkflowFromBytes loads a workflow from bytes.
LoadWorkflowFromReader loads a workflow from an io reader.
NewEvent creates a new event.
NewLogger creates a new logger instance and sets the right log level based.
NewLoggingContext creates a new logging context.
NewLogWriter creates a new LogWriter.
NewSpinnerForPreflight creates a new instance of Spinner based on the Options.
NewSpinnerForProbe creates a new instance of Spinner based on the Options.
NewSpinnerForStep creates a new instance of Spinner based on the Options.
PrintError prints an error to the console in red.
# Constants
EventRunError start failed.
EventRunFail ran but the command failed.
EventRunningProbe announces probing.
EventRunRequested run requested.
EventRunStarted run started.
EventRunSuccess ran with success.
EventRunTimeout run timed out.
EventRunWaitError ran but failed on wait.
FldStep is a logger field.
# Variables
Channel is the build channel.
CtxSpinner is the key to a spinner on the context.
Version is trackman version.
# Structs
CtxKey is a context key.
Event is a simple event.
LogDefinition is used to define where a logger should log to.
LoggingContext is a structure that holds workflow and step and is used to determine log configuration.
LogWriter implements io.Writer so it can be used to dump a process output but links it to logrus.
Payload is what's sent over to a notifier.
Preflight is a check that runs at the beginning of the workflow.
Probe defines a checker for a Step's health.
Spinner is the main component that runs a process.
Step is a single running Step.
StepOptions provides options for a Step.
Workflow is the internal object to hold a workflow file.
WorkflowOptions provides options for a workflow.