ControlTier > core
 
 
PDF -icon
PDF

Builder

An interface to a software builder.

Overview

Builder: An interface to a software builder.

Documentation

Documentation is available on the ControlTier Wiki: Core Type Guide - Builder

Design

Super Type
Deployment
Role Concrete. (Objects can be created.)
Instance Names Unique
Notification false
Template Directory
Data View Children, proximity: 1
Logger Name Builder

Constraints

Allowed Child Dependencies

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

Attributes

Exported Attributes

Name Property Description
basedir deployment-basedir Directory where source code is checked out
targetdir deployment-install-root Directory where build artifacts are written

Defaults for Imported Attributes

Name Default Description
buildFile Build file to invoke
buildTarget Target to invoke
importMax 1 maximum number of packages to import after build
importMin 1 minimum number of packages to import after build
packageBuildtimePattern yyyymmddhhmmss buildtime timestamp pattern
packageExtension .* name or pattern of file name extensions to import
packageFilebase .*? root name or pattern of filenames to import (minus file extension and option version qualifier)
packageInstallRank 0 Order in which the package is to be installed
packageInstallroot Directory built package should be extracted
packagePurgeRegex ^(?!^${entity.attribute.buildstamp}$).*$ Package purge builstamp selection regex
packageSeparator - default character used to separate the package version/buildstamp from the rest of the file base
packageType [^\.]* Object type to use when registering uploaded packages
packageVersion ${opts.buildstamp} String to use for assigning version for package registration
requireBuildstamp false Allow package files that do not include the provided buildstamp to be matched by default
scmBinding cvs binds scm commands to concrete SCM client commands (current implementations are cvs, svn, p4, git & none)
scmConnection connection string to access SCM repository
scmLabel name of the label/branch to access in SCM repository
scmModule name of code module in SCM repository
scmQuiet false sets scmQuiet activity to false
scmUser ${user.name} sets scmUser to default user name

Commands

View the available commands in the User Reference.

Related Types

The following types are defined for use with Builder.

BuilderAutoUpdate

Overview

BuilderAutoUpdate: Set to true to automatically update after build

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
autoUpdate settingValue

BuilderBuildFile

Overview

BuilderBuildFile: Build file the Builder should invoke

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
buildFile settingValue

BuilderBuildstamp

Overview

BuilderBuildstamp: Optional setting to contain the most recent buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
buildstamp settingValue

BuilderBuildTarget

Overview

BuilderBuildTarget: Build target the Builder should invoke

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
buildTarget settingValue

BuilderExportDestination

Overview

BuilderExportDestination: WebDAV URL or scp destinaton for package export

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
builderExportDestination settingValue

BuilderImportMax

Overview

BuilderImportMax: Maximum number of packages to import

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
importMax settingValue

BuilderImportMin

Overview

BuilderImportMin: Minimum number of packages to import

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
importMin settingValue

BuilderPackageBuildtimePattern

Overview

BuilderPackageBuildtimePattern: Optional setting to set the package buildtime property

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageBuildtimePattern settingValue

BuilderPackageExtension

Overview

BuilderPackageExtension: name or pattern of file name extensions to import

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageExtension settingValue

BuilderPackageFilebase

Overview

BuilderPackageFilebase: name or pattern of filenames to import (minus file extension)

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageFilebase settingValue

BuilderPackageInstallRank

Overview

BuilderPackageInstallRank: install-rank of the package

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageInstallRank settingValue

BuilderPackageInstallroot

Overview

BuilderPackageInstallroot: install-root path of package

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageInstallroot settingValue

BuilderPackagePurgeIgnoreparents

Overview

BuilderPackagePurgeIgnoreparents: Boolean flag specifying if purge should ignore if package has parent resource relations

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • false
  • true
  • false
true

Attributes

Exported Attributes
Name Property
packagePurgeIgnoreParents settingValue

BuilderPackagePurgeRegex

Overview

BuilderPackagePurgeRegex: Buildstamp regular expression used to drive package purge selection

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packagePurgeRegex settingValue

BuilderPackageRequireBuildstamp

Overview

BuilderPackageRequireBuildstamp: Whether or not to require that file names include the provided buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
requireBuildstamp settingValue

BuilderPackageSeparator

Overview

BuilderPackageSeparator: Character used to separate the package version (buildstamp) from the rest of the package file base

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageSeparator settingValue

BuilderPackageType

Overview

BuilderPackageType: Type of package

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageType settingValue

BuilderPackageVendor

Overview

BuilderPackageVendor: package vendor

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageVendor settingValue

BuilderPackageVersion

Overview

BuilderPackageVersion: package version

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
packageVersion settingValue

BuilderScmBinding

Overview

BuilderScmBinding: binds scm commands to concrete SCM client commands

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • cvs
  • none
  • p4
  • svn
false

Attributes

Exported Attributes
Name Property
scmBinding settingValue

BuilderScmConnection

Overview

BuilderScmConnection: source code repository connection string

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
scmConnection settingValue

BuilderScmLabel

Overview

BuilderScmLabel: Source label to build

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
scmLabel settingValue

BuilderScmModule

Overview

BuilderScmModule: Source module to build

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
scmModule settingValue

BuilderScmQuiet

Overview

BuilderScmQuiet: makes scm activity quiet

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
scmQuiet settingValue

BuilderScmUser

Overview

BuilderScmUser: scm user

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
scmUser settingValue

BuilderScmView

Overview

BuilderScmView: scm view (perforce)

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
scmView settingValue

BuilderSetting

Overview

BuilderSetting: A builder setting.

Design

Super Type
Setting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies

BuilderVersionBuild

Overview

BuilderVersionBuild: Optional version build number used to automatically generate the package buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
versionBuild settingValue

BuilderVersionMajor

Overview

BuilderVersionMajor: Optional version major number used to automatically generate the package buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
versionMajor settingValue

BuilderVersionMinor

Overview

BuilderVersionMinor: Optional version minor number used to automatically generate the package buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
versionMinor settingValue

BuilderVersionRelease

Overview

BuilderVersionRelease: Optional version release number used to automatically generate the package buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
versionRelease settingValue

BuilderVersionTag

Overview

BuilderVersionTag: Optional version tag used to automatically generate the package buildstamp

Design

Super Type
BuilderSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
versionTag settingValue