Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fixed typos, casing and added gernal functions

...

Expression Expansion

To initiate an expansion, simply type the dollar symbol '$' and the expression auto complete will present (note: not all objects are available in all fields).

...

NameDescriptionTypeUsage Examples
N/ARepresents the full path disk location of a buildsbuild's workspace folder.String$Workspace$\testfolder"D:\ContinuaAgent\Ws\19\"

...

NameDescriptionTypeUsage Example
IdA unique Integer allocated automatically to this buildString$Build.Id$"10"
VersionA reference object for the build version (as defined below).Version$Build.VersionVersion$N/A
StartedByThe username of the user who initiated the buildString$Build.StartedBy$"peter.toms@finalbuilder.com"
IsFeatureBranchBuildUtilised via build triggers, this . This expression is set to true when a build is triggered on a non-default branchBoolean$Build.IsFeatureBranchBuild$true
BuildNumberA 0 zero-based auto-incremented integer allocated to this build (the first build will be build 0, the second build 1, etc)Integer$Build.BuildNumber$100
MetricsA reference object to the metrics associated with this build (as defined below).Metrics$Build.Metrics$N/A
HasNewChangesDoes this build contain Changesets changesets which have not been associated with a previous build?Boolean$Build.HasNewChanges$true
LinkUrlBuild details UrlURLString$Build.LinkUrl$"http:\\SERVERNAME\New_Project_1\ci\builds\view\123" 

...

NameDescriptionTypeUsage Examples 
NameName of the Configuration configuration (as defined within the Configuration details page)String$Configuration.Name$"New Configuration 1"

...

NameDescriptionTypeUsage Example
PortThe Port port number used for agent communicationString$Agent.Port$"9000"
HostnameThe Agents Hostnameagents host nameString$Agent.Hostname$"AGENTMACHINE"
NowThe current date and time given as local to the agent localDatetime$Agent.Now$"2014 4:51:44 PM"
NowUTCThecurrent The current date and time given as UTCDatetime$Agent.NowUtc$"2014 6:52:25 AM"
InstallPathThe installation path of the agentString$Agent.InstallPath$"C:\Program Files\VSoft Technologies\ContinuaCIAgent\"
GetUserEnvironmentVairableGetUserEnvironmentVariableGets the specified Windows user Windows environment variable (relative to the agent machine's service user, and relative to the agent machine)String$Agent.GetUserEnvironmentVairableGetUserEnvironmentVariable("TEMP")$"%USERPROFILE%\AppData\Local\Temp"
GetMachineEnvironmentVairableGetMachineEnvironmentVariableGets the specified Windows machine Windows environment variable (relative to the agent machine) String$Agent.GetMachineEnvironmentVairableGetMachineEnvironmentVariable("NUMBER_OF_PROCESSORS")$"8"
N/AWithin this the Agent object is a list of the current agent property collectorsProperty Collector$Agent.NuGet.Default.Path$"C:\Program Files\NuGet\NuGet.exe"

...

NameDescriptionTypeUsage Example
NameThe name of the Project for which this the project the current configuration is a part of (as provided on the Project details page)String$Project.Name$"New Project 1"
DescriptionThe description of the Project for which this project the current configuration is a part of (as provided on the Project details page)String$Project.Description$"This is a description for new project 1"
SlugA shorterned shortened version of the Project project name which is safe to use within Url's URLs and other whitespace sensitive identifiers.String$Project.Slug$"New_Project_1"

...

NameDescriptionTypeUsage Example
N/AA List of the repositories associated with configurationWhat follows is a list of repositories associated with the given current configurationRepository$Source.Reponame$"Mercurial_Test_1"

...

NameDescriptionTypeUsage Example
NowThe current date and time given as local to the server localDateTime$Server.Now$"01/01/2014 5:03:18 PM"
NowUtcThe date and time given as UTCDateTime$Server.NowUtc$"01/01/2014 7:04:01 AM"
HostnameThe Continua server hostnameString$Server.Hostname$"SERVERMACHINE"
InstallPathThe Continua server install pathString$Server.InstallPath$"C:\Program Files\VSoft Technologies\ContinuaCI\"
UrlThe Server web service URLString$Server.Url$"http:\\SERVERNAME:8080"

...

NameDescriptionTypeUsage Example 
NewGuidCreate a new randomly generated GuidGUIDGuid$Utils.NewGuid$"da47b2d6-3580-48ed-b27a-f152da2345e6"
RandomNumber

Generate a new random integer value

If one parameter is provided it designates a random number in the range of greater than or equal to zero and the number provided will be generated

If two parameters are provided they designate the range for the generated number.

If no parameters are provided an a 32-bit integer greater than or equal to zero and less than int32 Int32 max value (2,147,483,647) will be generated.

Integer

$Utils.RandomNumber("1", "10")$

$Utils.RandomNumber("10")$

$Utils.RandomNumber$

5

2

1906529119 

...

NameDescriptionTypeUsage Example
BranchThe full name of the branch associated with the build for the given RepositoryrepositoryString$Source.RepoName.Branch$"/branches/a_test_branch"
BranchNameThe branch name of the branch associated with the build for the given RepositoryrepositoryString$Source.RepoName.BranchName$"a_test_branch"
LatestChangesetA reference object to the Changeset changeset information related to the most recent Changeset changeset for the given Repository repository (as defined below).Changeset$Source.RepoName.LatestChangeset.Comment$"a comment from the last commit"
PathThe disk location of the source associated with the build for the given RepositoryrepositoryString$Source.RepoName.Path$"C:\ContinuaAgent\Ws\44\Source\"
TagThe tag name (if one exists) associated with the build for the given RepositoryrepositoryString$Source.RepoName.Tag$"v3-release"
TypeThe Repository repository product being usedString$Source.RepoName.Type$"Mercurial"
UrlThe Url URL of the repository in question (as defined within the repository preferences)String$Source.RepoName.Url$"https://github.com/VSoftTechnologies/Delphi-Mocks.git"

...

NameDescriptionTypeUsage Example
IdA unique identifier given to this ChangesetchangesetString$Source.RepoName.LatestChangeset.Id$"a4ae66dffe5342e47c3aaf987bced4e9a320559e"
CommentThis comment associated with this Changeset changesetString$Source.RepoName.LatestChangeset.Comment$"This is a test commit"
RepositoryusernameRepositoryUsernameThe username of the repository user who committed this Changeset changesetString$Source.RepoName.LatestChangeset.RepositoryusernameRepositoryUsername$"Peter Toms"
BranchThe full branch path of the latest Changeset changeset associated with this Repository repositoryString$Source.RepoName.LatestChangeset.Branch$"/branches/a_test_branch"
BranchnameBranchNameThe branch name of the latest Changeset changeset associated with this Repository repositoryString$Source.RepoName.LatestChangeset.BranchnameBranchName$"a_test_branch"
CreatedThe created date of this Changeset (date and time when the Changeset changeset was committed or created within the source Repository) repositoryDatetime$Source.RepoName.LatestChangeset.Created$"11/09/2014 1:48:36 AM"
FilecountFileCountThe number of file changes associated with this commitInt$Source.RepoName.LatestChangeset.FilecountFileCount$1
CommitterusernameCommitterUserNameThe Username username of the Continua User who committed this changeset (if one exists based on user repository mappings )String$Source.RepoName.LatestChangeset.CommitterusernameCommitterUserName$"peter.toms@finalbuilder.com"
CommitterfullnameCommitterFullNameThe Full full name of the Continua user who committed this changeset (if one exists based on user repository mappings)String$Source.RepoName.LatestChangeset.CommitterfullnameCommitterFullName$"Peter Toms"

Anchor
stage
stage
Stage (used by $Source)

...

NameDescriptionTypeUsage Example
Compiler.WarningThe total number of compiler warnings for the current build (eg msbuild MSBuild or Visual Studio build warnings)Integer$Build.Metrics.Compiler.Warning$5
Compiler.ErrorThe total number of compiler errors for the current build (eg msbuild MSBuild or Visual Studio build errors)Integer$Build.Metrics.Compiler.Error$5
Unit TestsA reference object for the Unit Test Metric unit test metric detailsUnit Tests$Build.Metrics.UnitTestsN/A

...

NameDescriptionTypeUsage Example
DefaultA reference object for the default versionDefault$Build.Version.DefaultN/A
DotNetA reference object for the Dot .Net versionDotNet$Build.Version.DotNetN/A

...

NameDescriptionTypeUsage Example
MajorThe version major portion of the version numberInteger$Build.Version.DotNet.Major$"1" (given "1.2.0.1287")
MinorThe version minor portion of the version numberInteger$Build.Version.DotNet.Minor$"2" (fromgivengiven "1.2.0.1287")
BuildThe version build portion of the version numberInteger$Build.Version.DotNet.Build$"0" (given "1.2.0.1287")
RevisionThe version revision portion of the version numberInteger$Build.Version.DotNet.Revision$"1287" (given "1.2.0.1287")

 

Anchor
dotnet
dotnet
 General Functions

NameDescriptionTypeUsage Example
FormatFormats a date or time value using standard or custom .Net formatting stringsstring$Server.Now.Format("hh:mm")$"23:55" (given the date time "31/12/2000 23:55:333")
ToLowerConverts a string to lowercasestring$Source.RepoName.Branch.ToLower$"version 1.5" (given "Version 1.5")
ToUpperConverts a string to uppercaseInteger$Project.Name.ToUpper$"PROJECT X" (given "Project X")