Documentation
¶
Index ¶
- Constants
- func EvalBool(evaluator ExpressionEvaluator, expr string) (bool, error)
- func WithJobLogger(ctx context.Context, jobName string, config *Config, masks *[]string) context.Context
- type ActionReader
- type Config
- type ExpressionEvaluator
- type MappableOutput
- type RunContext
- func (rc *RunContext) ActionCacheDir() string
- func (rc *RunContext) AddMask(mask string)
- func (rc *RunContext) Clone() *RunContext
- func (rc *RunContext) CompositeExecutor() common.Executor
- func (rc *RunContext) Executor() common.Executor
- func (rc *RunContext) GetBindsAndMounts() ([]string, map[string]string)
- func (rc *RunContext) GetEnv() map[string]string
- func (rc *RunContext) NewExpressionEvaluator() ExpressionEvaluator
- func (rc *RunContext) String() string
- type Runner
- type StepContext
Constants ¶
const ActPath string = "/var/run/act"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ActionReader ¶ added in v0.2.26
type ActionReader interface {
// contains filtered or unexported methods
}
type Config ¶
type Config struct {
Actor string // the user that triggered the event
Workdir string // path to working directory
BindWorkdir bool // bind the workdir to the job container
EventName string // name of event to run
EventPath string // path to JSON file to use for event.json in containers
DefaultBranch string // name of the main branch for this repository
ReuseContainers bool // reuse containers to maintain state
ForcePull bool // force pulling of the image, even if already present
ForceRebuild bool // force rebuilding local docker image action
LogOutput bool // log the output from docker run
JSONLogger bool // use json or text logger
Env map[string]string // env for containers
Secrets map[string]string // list of secrets
InsecureSecrets bool // switch hiding output when printing to terminal
Platforms map[string]string // list of platforms
Privileged bool // use privileged mode
UsernsMode string // user namespace to use
ContainerArchitecture string // Desired OS/architecture platform for running containers
ContainerDaemonSocket string // Path to Docker daemon socket
UseGitIgnore bool // controls if paths in .gitignore should not be copied into container, default true
GitHubInstance string // GitHub instance to use, default "github.com"
ContainerCapAdd []string // list of kernel capabilities to add to the containers
ContainerCapDrop []string // list of kernel capabilities to remove from the containers
AutoRemove bool // controls if the container is automatically removed upon workflow completion
ArtifactServerPath string // the path where the artifact server stores uploads
ArtifactServerPort string // the port the artifact server binds to
CompositeRestrictions *model.CompositeRestrictions // describes which features are available in composite actions
NoSkipCheckout bool // do not skip actions/checkout
}
Config contains the config for a new runner
func (*Config) ContainerWorkdir ¶ added in v0.2.22
Resolves the equivalent host path inside the container This is required for windows and WSL 2 to translate things like C:\Users\Myproject to /mnt/users/Myproject
type ExpressionEvaluator ¶
type ExpressionEvaluator interface {
EvaluateYamlNode(node *yaml.Node) error
Interpolate(string) string
// contains filtered or unexported methods
}
ExpressionEvaluator is the interface for evaluating expressions
type MappableOutput ¶ added in v0.2.22
type RunContext ¶
type RunContext struct {
Name string
Config *Config
Matrix map[string]interface{}
Run *model.Run
EventJSON string
Env map[string]string
ExtraPath []string
CurrentStep string
StepResults map[string]*model.StepResult
ExprEval ExpressionEvaluator
JobContainer container.Container
OutputMappings map[MappableOutput]MappableOutput
JobName string
ActionPath string
ActionRef string
ActionRepository string
Composite *model.Action
Inputs map[string]interface{}
Parent *RunContext
Masks []string
}
RunContext contains info about current job
func (*RunContext) ActionCacheDir ¶ added in v0.2.2
func (rc *RunContext) ActionCacheDir() string
ActionCacheDir is for rc
func (*RunContext) AddMask ¶ added in v0.2.26
func (rc *RunContext) AddMask(mask string)
func (*RunContext) Clone ¶ added in v0.2.26
func (rc *RunContext) Clone() *RunContext
func (*RunContext) CompositeExecutor ¶ added in v0.2.26
func (rc *RunContext) CompositeExecutor() common.Executor
Executor returns a pipeline executor for all the steps in the job
func (*RunContext) Executor ¶
func (rc *RunContext) Executor() common.Executor
Executor returns a pipeline executor for all the steps in the job
func (*RunContext) GetBindsAndMounts ¶ added in v0.2.22
func (rc *RunContext) GetBindsAndMounts() ([]string, map[string]string)
Returns the binds and mounts for the container, resolving paths as appopriate
func (*RunContext) GetEnv ¶
func (rc *RunContext) GetEnv() map[string]string
GetEnv returns the env for the context
func (*RunContext) NewExpressionEvaluator ¶
func (rc *RunContext) NewExpressionEvaluator() ExpressionEvaluator
NewExpressionEvaluator creates a new evaluator
func (*RunContext) String ¶ added in v0.2.5
func (rc *RunContext) String() string
type StepContext ¶ added in v0.2.2
type StepContext struct {
RunContext *RunContext
Step *model.Step
Env map[string]string
Cmd []string
Action *model.Action
Needs *model.Job
}
StepContext contains info about current job
func (*StepContext) Executor ¶ added in v0.2.2
func (sc *StepContext) Executor(ctx context.Context) common.Executor
Executor for a step context
func (*StepContext) NewExpressionEvaluator ¶ added in v0.2.2
func (sc *StepContext) NewExpressionEvaluator() ExpressionEvaluator
NewExpressionEvaluator creates a new evaluator