Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "ALF/Build Vocabulary"

< ALF
(API)
(API)
Line 87: Line 87:
 
BuildResults Build(SCM Workspace,  ProjectName, BuildIdentifier, BuildConfiguration)
 
BuildResults Build(SCM Workspace,  ProjectName, BuildIdentifier, BuildConfiguration)
  
* Note: SCM Workspace Type allows as to obtain the Client Machine and the SCM Root Dir
+
 
 
</pre>
 
</pre>
  
Line 94: Line 94:
 
  BuildResults br = Build("Hello Snapshot","Hello World","Version 1","DEBUG");
 
  BuildResults br = Build("Hello Snapshot","Hello World","Version 1","DEBUG");
 
</pre>
 
</pre>
 +
 +
Notes:
 +
*SCM Workspace Type allows as to obtain the Client Machine and the SCM Root Dir
 +
* The ProjectName + BuildIdentifier will allow us to obtain the correct Build WorkSpace and then
 +
the BuildConfiguration will allow us to obtain the correct Build options within the Build Workspace.

Revision as of 13:01, 2 October 2006

Objects

Build Workspace

A Build Workspace corresponds to the SCM Workspace.

The Build Workspace would be identified by a Project + Identifier. For example, Project: Hello World + "Version 1".

Build Configuration

A Build Configuration is a pre-defined way a Build will run.

Within a Build Workspace there would be 0-N Build Configurations.

Build Properties

A Build Property is an option to the Build Engine.

A Build Configuration would contain 0-N, Build Properties.

Build Property

Target

Target - item to be built, ie. helloworld.jar

clean

clean - remove all Targets and Intermediate Targets in the Build Workspace

all

all - represents all Targets

ForceFullBuild

Force full build - indicate to the Build Engine to build regardless of timestamp or versions.

debug

debug - indicate to the Build Engine to perform a build using debug compile options

release

release - indicate to the Build Engine to perform a build using release compile options

BuildAsVersion

BuildAsVersion - version of the target to create, ie. helloworld-1.4.3.jar where 1.4.3 is the BuildAsVersion.

BuildLabel

BuildLabel - label used to indicate the Build or SCM label, ie. "Nightly Build"

BuildNumber

BuildNumber - number of the build, ie Build 327

BuildResults

BuildLog

  • File or http pointer to step output
  • 0-N occurrences
  • Type: String

ReturnCode

  • Over all SUCESS or FAILURE of the Build
  • Type: Integer (SUCESS = 1, FAILURE = 0)

StepReturnCode

  • Individual Step return codes
  • 0-N occurrences
  • Type: Integer

Reports

  • ReportType
  • File or http pointer to Build Reports
  • 0-N occurrences
  • Type: Dictionary - ReportType (Key, String) BuildReport (Value, URL)

BuiltTargetList

  • List of Targets that where built
  • 0-N occurrences
  • Type: String

FailedTargetList

  • List of Targets that where NOT built
  • 0-N occurrences
  • Type: String

FailedSourceList

  • List of Source File that had errors
  • 0-N occurrences
  • Type: String

API

BuildResults Build(SCM Workspace,  ProjectName, BuildIdentifier, BuildConfiguration)


Example: 
 BuildResults br = Build("Hello Snapshot","Hello World","Version 1","DEBUG");

Notes:

  • SCM Workspace Type allows as to obtain the Client Machine and the SCM Root Dir
  • The ProjectName + BuildIdentifier will allow us to obtain the correct Build WorkSpace and then

the BuildConfiguration will allow us to obtain the correct Build options within the Build Workspace.

Back to the top