BuildMaster Documentation

Artifacts - Deploy Artifact

  • Last Modified: 2019-07-30

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

Deploy Artifact

Retrieves the specified artifact from the artifact library and deploys it to a directory.

Script usage:

Deploy-Artifact(
	Name: <text>,
	[To: <text>],
	[Application: <text>],
	[Release: <text>],
	[Build: <text>],
	[Deployable: <text>],
	[DeployAsZipFile: <true/false>],
	[TransferAll: <true/false>],
	[DoNotClearTarget: <true/false>],
	[Verbose: <true/false>],
	[OverwriteReadOnly: <true/false>],
	[OptimizedFileTransfer: <true/false>]
);

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

Arguments:

Name Format Script Usage Usage Notes
Artifact name (default)
text
Name
This argument is required.
To directory
text
To
Application name
text
Application
Release number
text
Release
Build number
text
Build
Valid values are specific build numbers, or "furthest" or "latest".
Deployable name
text
Deployable
Deploy as zip
true/false
DeployAsZipFile
Transfer all files
true/false
TransferAll
By default, files will only be transferred if the last modified date or file size has changed. If set to true, all files will be transferred regardless if they have been modified.

This value should generally be set to false, except when it would take more time to compare the files than simply transferring and overwriting them all (i.e. the artifact contains thousands of small files).
Do not clear target
true/false
DoNotClearTarget
Verbose logging
true/false
Verbose
Overwrite read-only files
true/false
OverwriteReadOnly
Use optimized file transfer
true/false
OptimizedFileTransfer
Transfers artifact files using a new implementation that increases performance. This feature is still experimental, so verify results before using in production. This option is ignored if TransferAllFiles is true.

Note: Specifying "latest" as the source package number will attempt to retrieve the artifact from the most recently created build, whereas "furthest" will use the one that has been deployed to the furthest environment in the pipeline.

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