Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescriptionTypeUsage Example
IdA unique Integer allocated automatically to this buildString$Build.Id$"10"
VersionThe build version. This is derived from the configuration 'Version Format String' field on the configuration details tabVersion$Build.Version.Default.Major$"1"
StartedByThe username of the user who initiated the buildString$Build.StartedBy$"peter.toms@finalbuilder.com"
IsFeatureBranchBuildUtilized via build triggers, this descriptor is set to true when a build is triggered on a non-default branchBoolean$Build.IsFeatureBranchBuild$true
BuildNumberAn incremental number allocated to this build (The first build will be build number 0)Numeric$Build.BuildNumber$100
MetricsA placeholder for reference to the metrics object related to this build (eg the number of unit tests passed)defined below).Metrics$Build.Metrics$N/A
HasNewChangesDoes this build contain any new Changesets (which Continua has not yet seen)Boolean$Build.HasNewChanges$true
LinkUrlBuild details UrlString$Build.LinkUrl$"http:\\SERVERNAME\New_Project_1\ci\builds\view\123"

...

NameDescriptionTypeUsage Example
PortThe Port number used for agent communicationString$Agent.Port$"9000"
HostnameThe Agents HostnameString$Agent.Hostname$"AGENTMACHINE"
NowThe current date and time given as agent localDatetime$Agent.Now$"2014 4:51:44 PM"
NowUTCThe 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\"
GetUserEnvironmentVairableGets the specified user environment variable (relative to the agent machine's service user, and relative to the agent machine)String$Agent.GetUserEnvironmentVairable("TEMP")$"%USERPROFILE%\AppData\Local\Temp"
GetMachineEnvironmentVairableGets the specified Machine Environment Variable (relative to the agent machine) String$Agent.GetMachineEnvironmentVairable("NUMBER_OF_PROCESSORS")$"8"
N/AWhat follows is a A list of property collectorsProperty Collector$Agent.NuGet.Default.Path$"C:\Program Files\NuGet\NuGet.exe"

...

NameDescriptionTypeUsage Example 
NewGuidCreate a randomly generated GuidGuid$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 32-bit integer greater than or equal to zero and less than int32 max value (2,147,483,647) will be generated.

Integer

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

$Utils.RandomNumber("10")$

$Utils.RandomNumber$

5

2

1906529119 

Repository (used by $Source )

NameDescriptionTypeUsage Example
BranchThe full name of the branch associated with the build for the given repositoryString$Source.RepoName.Branch$"/branches/a_test_branch"
BranchNameThe branch name of the branch associated with the build for the given repositoryString$Source.RepoName.BranchName$"a_test_branch"
LatestChangesetA placeholder reference object for the changeset information related to the most recent changeset for the given repositoryChangeset$Source.RepoName.LatestChangeset.Comment$"a comment from the last commit"
PathThe disk location of the source associated with the build for the given repositoryString$Source.RepoName.Path$"C:\ContinuaAgent\Ws\44\Source\"
TagThe tag name (if one exists) associated with the build for the given repositoryString$Source.RepoName.Tag$"v3-release"
TypeThe Repository product being usedString$Source.RepoName.Type$"Mercurial"
UrlThe 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 id given to this changesetString$Source.RepoName.LatestChangeset.Id$"a4ae66dffe5342e47c3aaf987bced4e9a320559e"
CommentThis comment associated with this changesetString$Source.RepoName.LatestChangeset.Comment$"This is a test commit"
RepositoryusernameThe username of the user who committed this changesetString$Source.RepoName.LatestChangeset.Repositoryusername$"Peter Toms"
BranchThe full branch path of the latest changeset associated with this repositoryString$Source.RepoName.LatestChangeset.Branch$"/branches/a_test_branch"
BranchnameThe branch name of the latest changeset associated with this repositoryString$Source.RepoName.LatestChangeset.Branchname$"a_test_branch"
CreatedThe created date of this changeset (when the changeset was created within the source repository)Datetime$Source.RepoName.LatestChangeset.Created$ "11/09/2014 1:48:36 AM"
FilecountThe number of file changes associated with this commitInt$Source.RepoName.LatestChangeset.Filecount$ 1
CommitterusernameThe Username of the Continua User who committed this changeset (if one exists based on user repository mappings )String$Source.RepoName.LatestChangeset.Committerusername$ "peter.toms@finalbuilder.com"
CommitterfullnameThe Full name of the Continua user who committed this changeset (if one exists based on user repository mappings)String$Source.RepoName.LatestChangeset.Committerfullname$ Peter Toms

Stage (used by $Source)

NameDescriptionTypeUsage Example
NameThe stage name as defined within the workflow editorString"Build stage"$
MetricsA reference object for the metrics related to this build (defined below).MetricsN/AN/A   Metrics   

Metrics (used by $Build)

NameDescriptionTypeUsage Example
Compiler.WarningThe total number of compiler warnings for the current build (eg 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 or Visual Studio build errors)Integer$Build.Metrics.Compiler.Error$5
Unit TestsA placeholder object for the Unit Test Metric detailsUnit Tests$Build.Metrics.UnitTests.Passed$10

Unit Tests (used by $Build.Metrics)

NameDescriptionTypeUsage Example
FixtureCountThe total number of compiler warnings for the current build (eg msbuild or Visual Studio build warnings)Integer$Build.Metrics.UnitTests.FixtureCount$5
CaseCountThe total number of compiler errors for the current build (eg msbuild or Visual Studio build errors)Integer$Build.Metrics.UnitTests.CaseCount$5
PassedA placeholder object for the Unit Test Metric detailsInteger$Build.Metrics.UnitTests.Passed$10
FailedThe number of failed testsInteger$Build.Metrics.UnitTests.Failed$5
ErrorThe number of tests in errorInteger$Build.Metrics.UnitTests.Error$1
NotRunThe number of tests not runInteger$Build.Metrics.UnitTests.NotRun$1
InconclusiveThe number of inconclusive testsInteger$Build.Metrics.UnitTests.Inconclusive$1
IgnoredThe number of ignored testsInteger$Build.Metrics.UnitTests.Ignored$1
InvalidThe number of invalid testsInteger$Build.Metrics.UnitTests.Invalid$1
SkippedThe number of skipped testsInteger$Build.Metrics.UnitTests.Skipped$1   Unit Tests   

Version (used by $Source)

NameDescriptionTypeUsage Example 
MajorThe integer that denotes the current version major portionInteger   
MinorThe integer that denotes the current version Minor portionInteger   
BuildThe integer that denotes the current version Build portionIntegerBuild   
RevisionThe integer that denotes the current version Revision portionInteger