BuildMaster Documentation

Source Control - Get Labeled

  • 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.

Get Labeled

Gets the version of code from a repository with the specified label or tag.

Script usage:

Get-Labeled-Source(
	Provider: <text>,
	Label: <text>,
	[SourcePath: <text>],
	[ToDirectory: <text>],
	[ClearTarget: <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
Provider name
text
Provider
This argument is required.
Label/tag
text
Label
This argument is required.
Source path
text
SourcePath
The path in source control to get labeled from. This path is a provider-specific string that may include additional information like branch name, etc. See the documentation on inedo.com regarding the specific source control system in use.
To directory
text
ToDirectory
Clear target
true/false
ClearTarget
When set to true, clears the target directory before getting the files.

Example:

# get the files tagged rel-0.1.4 under MarketingPortal from the provider named Mercurial2, using the remote URL supplied in the 
# HdarsRepo repository on the master branch 
Get-Latest-Source(
    Provider: Mercurial2,
    Label: rel-0.1.4,
    From: HdarsRepo|master:MarketingPortal/
);

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