BuildMaster Documentation

BuildMaster - Create Build

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, 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.

Create Build

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

Script usage:

Create-Build(
	Application: <text>,
	[ReleaseNumber: <text>],
	[Pipeline: <text>],
	[Variables: <%(key1: value1, ...)>],
	[ForcePromotion: <true/false>],
	[Wait: <true/false>],
	[FailIfCannotCreate: <true/false>]
);

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
In application
text
Application
This argument is required.
For release number
text
ReleaseNumber
This may be a specific release number, "latest" or "all".
With pipeline
text
Pipeline
This is used if ReleaseNumber is empty.
Build variables
%(key1: value1, ...)
Variables
Force past gate
true/false
ForcePromotion
Wait for execution
true/false
Wait
Fail if nothing created
true/false
FailIfCannotCreate

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

Note: When FailIfCannotCreate is specified, the execution will halt if there are no valid builds to create; for example, if the targeted release number doesn't exist. Otherwise, a warning will be issued.

Example:

Create-Build
(
    Application: Hdars.Packager,
    ReleaseNumber: latest,
    Variables: %(ReleaseCandidate: true, PackageType: $PackageType)
);

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 ced119d5 on master