Descriptors

Descriptors provide a mechanism to autocomplete values which may not be known until build execution time.

Name	Description	Type	Example
	The disk location on the server for the build workspace	string	$Workspace$\testfolder

Name	Description	Type	Example
Id	Unique Integer allocated for this build	string	$Build.Id$
Version	The build version. This is derived from the configuration 'Version Format String' field on the configuration details tab	Version	$Build.Version.Default.Major$
StartedBy	The username of the user who initiated the build	string	$Build.StartedBy$
IsFeatureBranchBuild	Utilized via build triggers, this descriptor is set to true when a build is triggered on a non-default branch	Boolean	$Build.IsFeatureBranchBuild$
BuildNumber	The total number of builds	Numeric	$Build.BuildNumber$
Metrics		Metrics	$Build.Metrics$
HasNewChanges		Boolean	$Build.HasNewChanges$
LinkUrl		string	$Build.LinkUrl$

Name	Description	Type	Example
Name	Name of the Configuration as defined on the Configuration Details	string	$Configuration.Name$

Name	Type	Example
Port	string	$Agent.Port
Hostname	string
Now	date time
NowUTC	date time
InstallPath	string
GetUserEnvironmentVairable	string
GetMachineEnvironmentVairable	string
List of Property Collectors	Property Collector	$Agent.NuGet.Default.Path$

Name	Type	Example
Name	string	$Project.Name.ToLower$
Description	string	$Project.Description.ToLower$
Slug	string	$Project.Slug.ToLower$

Name	Description	Type	Example
List of the repositories associated with configuration		Repository	$Source.Reponame

Name	Type	Example
Now	DateTime	$Server.Now.Day$
NowUtc	DateTime	$Server.NowUtc.Month$
Hostname		$Server.Hostname.ToLower$
InstallPath		$Server.InstallPath.ToLower$
Url		$Server.Url.ToLower$

Name	Type	Example
Branch	String	$Source.aa.Branch.ToLower$
BranchName	String	$Source.aa.BranchName.ToLower$
LatestChangeset	Changeset	$Source.aa.LatestChangeset.Comment$
Path	String	$Source.aa.Path.ToLower$
Tag	String	$Source.aa.Tag.ToLower$
Type	String	$Source.aa.Type$
Url	String	$Source.aa.Url$

Name	Description	Type	Example
Name
Metrics

Name	Description	Type	Example
Compiler
Unit Tests

Page tree