BuildMaster Documentation

BuildMaster - Invoke Plan

  • Last Modified: 2020-11-06

This is generated from the built-in components of BuildMaster 6.2.21, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Invoke Plan

Executes an OtterScript plan stored in BuildMaster.

Script usage:

Invoke-Plan(
	Plan: <text>,
	[AdditionalVariables: <%(key1: value1, ...)>],
	[CaptureOutputVariables: <@(text)>]
);

This operation may be prefixed with BuildMaster::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
Plan (default)
text
Plan
This argument is required.
Additional variables
%(key1: value1, ...)
AdditionalVariables
Specify variables to pass in to the plan using a map. For example: %(var1: MyVariableValue, var2: @(list,of,items))
Capture output variables
@(text)
CaptureOutputVariables
Specify variables to capture and set in the calling scope using a list. For example: @(filePath,errorMessage)

Note: Runtime variables you've defined before executing an Invoke operation will not be visible to the invoked script, and variables that you set within the invoked script will not be available.

Example:

# This will call the global "MyPlan" deployment plan and pass in a variable called $name with value "Steve"
Invoke-Plan global::MyPlan
(
    AdditionalVariables: %(name: Steve)
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 46e90aca on master