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.

Deploy Build

Modified on July 26, 2024

Deploys a build in BuildMaster of an application, and optionally waits for it to complete.

Script usage:

Deploy-Build(
	Application: <text>,
	[ReleaseNumber: <text>],
	[BuildNumber: <text>],
	[Variables: <%(key1: value1, ...)>],
	[From: <text>],
	[To: <text>],
	[Force: <true/false>],
	[Wait: <true/false>],
	[FailIfCannotDeploy: <true/false>]
);

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

Arguments:

NameFormatScript UsageUsage Notes
In application
text
Application
This argument is required.
For release number
text
ReleaseNumber
This may be a specific release number, "latest" or "all". Default value is "latest".
Build number
text
BuildNumber
Select a specific build number. This may also be left blank to select all active builds. Value note: "(all active builds)".
Deployment variables
%(key1: value1, ...)
Variables
Value note: "%(var1: 1000, var2: $HdarFsServer, ...)".
From stage
text
From
To stage
text
To
Force past gate
true/false
Force
Wait for deployments
true/false
Wait
Default value is "True".
Fail if nothing is deployed
true/false
FailIfCannotDeploy

Note: When all releases is specified, then a build in *each* release will be created.

Note: When "from" or "to" pipeline stages are specified, only packages that come from or are going to those stages in their pipeline will be deployed.