Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.
 
No matching results found

Other Statements

view on GitHub

In addition to running operations and other plans as templates, the following statements are available:

In addition to running operations and other plans as templates, the following statements are available:

  • Set Variable – define or update values
  • Log – write messages to the execution log
  • Set Status – manually change the execution status
  • Raise Error – explicitly trigger an error
  • Await – pause execution to wait for asynchronous processes

Set Variable Statement

This will both declare and set the value of a variable for the current and all nested blocks. If a variable was already set, and declared in a parent block, then the variable's value will be set.

If a variable is specified outside of the plan execution (for example, a variable on a Server or Environment), setting the value within the plan will not change the external value, but will instead only create an alias for the current block. You should try to avoid doing this when possible.

set $EnvironmentName = Production;

Log Statement

This statement will write text to the execution log at the specified level (Debug, Information, Warn, Fail), and may change the execution status.

If you log at the Fail level, then the execution status will be set to Fail, but other blocks and statements will execute as per normal. If you log Warning, the status will change to Warn unless it's already Fail.

log-information "Deployment started.";
Log Level Behavior
-debug Only shown in verbose logs
-information Standard logs
-warning Writes a warning message to Standard logs
-error Writes an error message to Standard Logs
  • Logging a -warning message will set the execution status to warn
  • Logging an -error message will set the execution status to fail

Set Status

The execution status is generally set by the success or failure of operations in a plan, but you can also change the status to Fail or Warn as needed. This is commonly used inside of the Catch (On Error) portion of a Try/Catch block to set the status to the desired level.

Execution Status Behavior
warn Executions will complete with a warning
fail Executions will fail
force normal Executions will complete as successful

Examples:

warn;

force normal;

Raise Error

You can halt the execution engine, in either a recoverable (i.e. inside of a Try/Catch block) or irrecoverable manner. In both cases, the execution status will be set to Fail.

raise-error "Critical file not found.";

Await

You can also pause the execution engine and wait for asynchronous blocks to complete; if you only want to wait for certain blocks, specify the same token in both the block and the await statement.

Basic Usage:

await;

With a Token:

await TokenName;

inedo.com | Support | MyInedo

docs © 2025 Inedo, LLC