Runner Tasks

Pull and start a container image on device

# Name Human referencable name for the container
name: <string>
# Image Reference to the container source, version, and tags
image: <string>
# Ports List of ports defined by colon pairs to expose
ports: <[]string>
# Environment Variables to inject in to the container environment
environment: <[]string>
            

Decompress a wide variety of archives

# Destination Where to unpack the archive to on file system
destination: <string>
# SkipSymlinks If encountering symlinks within the archive, should they be skipped
skip_symlinks: <bool>
# PreservePermissions Keep file permissions as defined within the archive
preserve_permissions: <bool>
# RemoveExisting If the destination already exists, should it be cleaned prior to decompress
remove_existing: <bool>
# Source File system path to the archive to be worked on
source: <string>
            

Make sure a block of content exists within a file using markers to control presence

# Reference Unique Identifier for the content block to be used as a key
reference: <string>
# Contents String to be included within the block
contents: <string>
# Destination Path to the file to create / include contents within
destination: <string>
# Regex A dynamic way to determine content presence without use of reference. Should only be used in edge situations
regex: <string>
# Remove Delete instead of insert. Will also remove the file marker
remove: <bool>
# MarkerStart Custom block opener. Default JOYDX_START:
marker_start: <string>
# MarkerEnd Custom block close. Default JOYDX_END:
marker_end: <string>
# CommentStart Custom comment marker. Default #
comment_start: <string>
            

Copies files / directories from one path to another

# Source File System Path to files to be copied
source: <string>
# Destination Target file system path
destination: <string>
# SkipIfGitChanged If source is GIT repository, skip if destination has changes or on diff branch
skip_if_git_changed: <bool>
# RemoveExisting If destination already exists, remove before copying
remove_existing: <bool>
            

Create a symbolic link

# Source Path to the real file node being linked to
source: <string>
# Destination Path link to original file is made
destination: <string>
            

Create a directory on the file system

# Path File system path for directory to create
path: <string>
            

Change the permission bits for a given path

# Path Target path for operation
path: <string>
# PermissionBits User/Group/Other read/write/execute
permission_bits: <os.FileMode>
            

Move a file / path to another location on the system

# Source File System Path to files to be copied
source: <string>
# Destination Target file system path
destination: <string>
            

Write contents to a new or existing file. If file exists, will be appended

# Contents String to be included within the block
contents: <string>
# Destination Target file system path
destination: <string>
# IgnoreContentsMerge If the file already exists, overwrite existing contents
ignore_contents_merge: <bool>
            

A simple logger used for outputting information to the console

# Data Contents to be written out to console. If not string / int type, will be dumped
data: <unknown>
            

Spawn a separate process for executing the equivalent of terminal commands

# Background Whether to consider the action complete once command started. Output will still be captured
background: <bool>
# Command The operation to perform. Each slice element represents adding a space to the command
command: <[]string>
# Debug Whether to output verbose information regardless of settings
debug: <bool>
# Environment Extra variables to be made available to the command via the environment
environment: <[]string>
# RegisterOutputToVar Upon program completion, variable name (core service) to save the output buffer to
register_output_to_var: <string>
# ShowOutput Whether to also pipe the program output to stdout. Useful for debugging purposes
show_output: <bool>
# WorkingDir File system path command should run from
working_dir: <string>
# TrimOutput For final output, strip leading spaces
trim_output: <bool>
            

Check whether an executable is available to $PATH for the current user

# Executable Name of the process to check for
executable: <string>
            

Read the contents of a given file in to a variable

# FilePath File system path to source file for reading
file_path: <string>
# VarToSave Variable to save file contents to
var_to_save: <string>
            

Set a variable within the core service for later consumption

# VarValues A map of values to write to variable service
var_values: <unknown>
            

Add an environment variable to a given workspace to be included by default in command calls

# VarValues List of variables to include
var_values: <[]string>
            

Use one of the dynamic macros defined within the environment playbook

# InputValues Variable values to be used with the macro
input_values: <unknown>
# MacroRef Reference for the macro to be used as defined within the environment profile
macro_ref: <string>
            

Pull code from a remote repository

# Branch Optionally use a specific branch of the remote repository
branch: <string>
# CheckoutURL Manually specific clone address instead of using RepositoryURL to calculate
checkout_url: <string>
# Destination Target file system path
destination: <string>
# PullIfExists If the destination already exists, should JoyDX still try to fetch remote content
pull_if_exists: <bool>
# ResetIfModified If the destination already exists and has unstaged GIT changes, should JoyDX perform a reset
reset_if_modified: <bool>
# RepositoryURL repo home page. service calculates checkout method based on accounts
repository_url: <string>
# CheckoutPrivateKeyPath Manually specify SSH key file system path for use in checkout.
checkout_private_key_path: <string>
# Source Manually specify how repo should be checked out
vcs_account_ref: <string>
            

Download a file to local system from network

# Blocking Should the download be carried out in the background (default) or force the playbook to wait until completion
blocking: <bool>
# URL Source of the download
url: <string>
# DestinationFolder Used if path not set appending
destination_folder: <string>
# OutputFileName Full path on local file system to save file
output_filename: <string>
# OverwriteIfExists Replace the destination file if it exists. If false and file exists, download will be considered complete without any work
overwrite: <bool>
# SkipAllowedPaths Should download destination ignore the allowed paths check.
skip_allowed_paths: <bool>
            

Generic action for performing a network request

# Method HTTP method to make the request with
method: <string>
# URL Network endpoint for request
url: <string>
# Body Request contents to be included
body: <unknown>
# BodyType application/json, application/x-www-form-urlencoded
body_type: <string>
# Headers Extra meta information to attach within the header section of the request
headers: <unknown>
            

Allow use of a JoyDX managed tool even if not installed within the environment

# CommandParameters Extra parameters to be suffixed to the command
command_parameters: <[]string>
# Environment Extra variable definitions to be made available to the command via environment variables
environment: <[]string>
# Executable File name of the executable to be used. Must exist within the toolspec
executable: <string>
# ToolRef Reference to the tool to be used
tool_ref: <tooldto.ToolRef>
# Version If targeting a specific release of a tool. Uses latest by default
version: <string>