README
¶
run_shell Task
Description
The run_shell task executes a series of commands within a shell environment. This task is especially useful for complex operations that require executing a shell script or a sequence of commands within a specific shell.
Configuration Parameters
-
shell:
Specifies the type of shell to use for running the commands. Common shells includesh,bash,zsh, etc. The default issh. -
shellArgs:
Additional arguments to pass to the shell. Example:--login. -
envVars:
A dictionary specifying the environment variables to be used within the shell. Each key in this dictionary represents the name of an environment variable, and its corresponding value indicates the name of a variable from which the actual value should be read.
For instance, ifenvVarsis set as{"PATH_VAR": "MY_PATH", "USER_VAR": "MY_USER"}, the task will use the values ofMY_PATHandMY_USERvariables from the current task variable context as the values forPATH_VARandUSER_VARwithin the shell. -
command:
The command or series of commands to be executed in the shell. This can be a single command or a full script. The commands should be provided as a single string, and if multiple commands are needed, they can be separated by the appropriate shell command separator (e.g., newlines or semicolons inshorbash).
Output Handling
The run_shell task scans the standard output (stdout) of the shell script for specific triggers that enable actions from within the script.
For instance, a script can set a variable in the current task context by outputting a formatted string.
An example of setting a variable USER_VAR to "new value" would be:
echo "::set-var USER_VAR new value"
This feature allows the shell script to interact dynamically with the task context, modifying variables based on script execution.
Please note that this feature is still under development and the format of these triggers may change in future versions of the tool. It's important to stay updated with the latest documentation and release notes for any modifications to this functionality.
Defaults
Default settings for the run_shell task:
- name: run_shell
config:
shell: bash
shellArgs: []
envVars: {}
command: ""
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "run_shell" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Runs commands in a shell.", Category: "utility", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{}, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
Shell string `yaml:"shell" json:"shell" desc:"Shell interpreter to use (e.g., bash, sh, zsh)."`
ShellArgs []string `yaml:"shellArgs" json:"shellArgs" desc:"Additional arguments to pass to the shell."`
EnvVars map[string]string `yaml:"envVars" json:"envVars" format:"expressionMap" desc:"Environment variables to set for the shell command."`
Command string `yaml:"command" json:"command" require:"A" format:"shell" desc:"The shell command to execute."`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files