Cruise. Control Configuration Reference. Cruise. Control configuration files are written in XML. This document. describes the XML elements and attributes for a valid configuration.
Workbench User Guide Eclipse platform overview Getting started Basic tutorial The Workbench Editors and views Editors Views.
The use of plugins means that other. At a minimum, though, the config file contains a single top level. The < cruisecontrol> element is the root element. Child Elements. Element. Cardinality. Description< system> 0 . Currently just a placeholder for the < configuration> element. We expect that in the future, more system- level features can be configured under this element.
Defines a basic unit of work.< plugin> 0 . Registers a classname with an alias.< property> 0 .
Ant Update Properties File Viewer
Defines a name/value pair used in configuration.< include. Add projects defined in other configuration files.< dashboard> 0 . Configure dashboard related settings. The < threads> element can be used to configure the number of threads that Cruise. Control can use. simultaneously to build projects.
This is done through the count attribute. If this element (or one of its parent elements) is not specified, this defaults to 1. This means that only one project will be built at a time. Raise this number if your server has enough resources to. If more projects than the maximum. Attributes. Attribute.
Required. Descriptioncount. Yes. Maximum number of threads to be in use simultaneously to build projectstop. The < property> element is used to set a property (or set of properties). Cruise. Control configuration file. Properties may be set at the global level. There are three ways to set properties within Cruise.
Overview of Apache Ant Tasks. Given the large number of tasks available with Ant, it may be difficult to get an overall view of what each task can do. If you're currently not using Eclipse as your development tool of choice, you certainly should be! Eclipse is an open source community whose projects are.
Control: By supplying both the name and value attributes. By setting the file attribute with the filename of the property file to load. This property file must follow the format defined by the class java. Properties. with the same rules about how non- ISO8.
By setting the environment attribute with a prefix to use. Properties will be defined. Properties in Cruise. Control are not entirely immutable: whoever sets a property last. In other words. you may define a property at the global level, then eclipse this value within the scope of a single.
You may not, however, set a property more. If you do so, only the last assignment will be used. Just as in Ant, the value part of a property being set may contain references to other properties.
Ant-Man is a 2015 American superhero film based on the Marvel Comics characters of the same name: Scott Lang and Hank Pym. Produced by Marvel Studios and distributed. Applying Ant Colony Optimization algorithms to solve the Traveling Salesman Problem.; Author: geoyar; Updated:; Section: Algorithms & Recipes; Chapter. CruiseControl Configuration Reference. CruiseControl configuration files are written in XML. This document describes the XML elements and attributes for a valid. I get checksum errors when I try to extract the tar.gz distribution file. Why? Ant's distribution contains file names that are longer than 100 characters.
Ant Update Properties File In Eclipse
These references are resolved at the time these properties are set. This also holds for properties.
Also note that the property ${project. Finally, note that properties bring their best when combined with. Attributes. Attribute. Required. Descriptionname. Exactly one of name, environment, or file. The name of the property to set.
The prefix to use when retrieving environment variables. Thus if you specify environment="myenv" you will be able. OS- specific environment variables via property.
PATH" or "myenv. MAVEN_HOME". The filename of the property file to load.
Yes, if name was set. The value of the property. This may contain any previously. No. Used in conjunction with environment. If set to true, all. Examples. Set a couple of global properties using name/value pairs.
Set a collection of global properties from the properties file "config. Load the system's environment into a collection of global properties. Uppercase all environment variable names. CCDIR}/logs"/>. Define a global property called "buildmanager".
Override it's value. As demonstrated here, properties and.
Load environment variables - ->. Commonly used directories - ->. CCDIR}/report"/>. CCDIR}/checkout/${project. CCDIR}/logs/${project.
Defaults for email - ->. Buildmaster"/>. Preconfigure our plugins - ->. ANT_HOME}/bin/ant". Working. Dir="${projectdir}". BUILD ${project. name}]". The < include.
One advantage over using XML includes are that. XML. fragments. Also, including projects using the tag is less fragile as an error in one. Configuration files included this way are processed with the properties and.
Properties and plugins defined in the processed files are not made. Project names must still remain unique. The first project with a given name will. Changes to any of the included file with be detected and cause the configuration to be reload. Attributes. Attribute. Required. Descriptionfile.
Yes. Relative path from current configuration file to the configuration file to process. The < dashboard> tag is used to set the configuration for build loop posting builds information to the dashboard. If this element is not specified in config. Cruise. Control will first check command- line. If neither of this set, then Cruise. Control will use default.
Attributes. Attribute. Required. Descriptionurl. No. Home page address of your dashboard.
The default value is http: //localhost: 8. No. The interval [in seconds] that build loop post builds information to the dashboard. The default value is 5 seconds. A < project> is the basic unit of work — it.
Note: one config. Attributes. Attribute. Required. Descriptionname. Yes. Unique identifier for this projectbuildafterfailed.
No (defaults to true)Should Cruise. Control keep on building even though it has. This feature is. useful if you want Cruise.
Control to detect situations where a. Build. New. Project. No (defaults to true)Should Cruise. Control force a project to build if the serial. SER) is not found, typically this is when the. This feature is useful for. Modification. No (defaults to true)Is a modification required for the build to continue?
Default value is true. Useful to set to false when the schedule. Only. No (defaults to false)Indicate that the build for the project only occurs when forced. Note that if the build. After. Failed attribute is true, then. Child Elements. Element. Cardinality. Description< listeners> 0 .
Container element for Listener plugin instances.< bootstrappers> 0 . Container element for Bootstrapper plugin instances.< modificationset> 1. Container element for Source.
Control plugin instances.< schedule> 1. Specifies the Source. Control poll interval, and is a parent. Builder plugin instances.< log> 0 . Specifies where project log files are stored.< publishers> 0 . Container element for Publisher plugin instances.< plugin> 0 . Registers a classname with an alias.
The < listeners> element is a container element. Listener plugin instances. Listeners are notified with every Project. Event but most Listeners. Project. Event. Child Elementstop.
The < cmsynergysessionmonitor> listener will monitor and start CM Synergy. It is triggered with each build loop (before the bootstrappers. CM Synergy sessions. The < cmsynergysessionmonitor>. CM Synergy session ID. This map is persisted in a simple. Each time the < cmsynergysessionmonitor> runs, it will load the persisted information from.
It does this according to the following rules: If the session file does not exist, it will be created. If an entry for the session name does not exist in the session file, a new CM Synergy. If an entry for the session name does exist in the file, it will check that the CM Synergy. ID associated with the session name is still running. If it is, no further action is. If it is not, a new CM Synergy session is started, and the new ID recorded in the.
If you are planning to run Cruisecontrol as a headless scheduled task, you may encounter an error. Cannot open logfile 'C: \\ccm_ui. This issue can be worked around. System Environment Variable. Value. CCM_ENGLOG${path to build Synergy users ccm_eng. CCM_UILOG${path to build Synergy users ccm_ui.
Attributes. Attribute. Required. Descriptionccmexe. No. The name of the CM Synergy command line client. If not provided, the. Windows). sessionfile.
No. The session file used to persist the CM Synergy session information. If not provided, it defaults to a file called ".
Child Elements. Element. Cardinality. Description< session> 1 . Defines a CM Synergy session you wish to monitor. The session. information may be provided in one of two ways. You may provide each individual attribute directly in the config file.
You may specify the name attribute as well as an "attributefile". This allows. you to place sensitive information - such as the password - into an. The file referenced here. Attribute. Required. Descriptionname. Yes. The name of the CM Synergy session. This value will be used in the.
CM Synergy plugins. No. The properties file which will be read to set the remainder of the. Yes. The CM Synergy database with which this session will communicate. Yes. The CM Synergy user account under which the session will run. Yes. The password for the specified user.
Yes. The role under which the CM Synergy session will run. No. If you wish the CM Synergy session to run on a host other than the. No. If CM Synergy is running on a UNIX environment and the database is not locally accessible, set this to true. Examples. Monitor two sessions. The first will be associated with the database. We will specify all attributes in the config file for the first.
We will accept the default session file location of. Both sessions will run on. P@ss. W0rd!"/>. Session 2 would then use a properties file as follows. CM Synergy session properties for "session. P@ss. W0rd! top. Provides the means to execute another publisher (or set of publishers). This is accomplished by simply adding any desired publishers as child.
All child elements must meet the following criteria. They must be registered as publishers. If you are adding a publisher. Cruise. Control, this will be done for you automatically. If you are adding a custom publisher, you must remember to register it with.
Cruise. Control using a. They must validate successfully regardless of whether or not. Child Elements. Element. Cardinality. Description. Any defined publisher. You may use any defined publisher as a child element. Examples. After a build, use the x.
Ant script to do some cleanup. Code="A" device. Code="3"/>. The Cruise. Control Build Results JSP can indicate whether or not.
Cruise. Control is currently building a project. To get this information. JSP, we can use the optional. HTML. snippet to disk in a location where the JSP can read it. This file will. consist of the current status of the build and the last time the status. Attributes. Attribute.
Required. Descriptionfile. Yes. The filename to write, including pathtop.
Updates replaceable text in a pattern file each time the Project status changes. Can show full project status history. The following items will be replaced with their values each time they occur in the source file: {Project} - Project Name.{State. Name} - Name of current project state.{State.
Description} - Description of current project state.{State. Date} - Date/time the current state happened{State. Duration} - How long since this state was in effect. Only useful in {History} line.){History} - Historical states. Must be first on line. This line will be processed and output once for each state the project has previously been in. The {History} tag will be deleted from the line.
A default template is provided of the form "{Project}: {State. Date} - {State. Name}: {State. Description}"Attributes. Attribute. Required. Descriptionfile. Yes. The filename to write, including pathsource. File. No. The file with the template to use for subtitutiontop.
This plugin is mostly identical to the < currentbuildstatuslistener> , to which it adds sending the HTML. FTP server. Attributes.
Attribute. Required. Descriptionfilename. Yes. The filename to write, including pathdestdir. Yes. The remote directory in which the file will be sent to. This plugin works in conjunction with a < lockfilebootstrapper> to define a set of projects that will not build simultaneously in a multithreaded build environment.
This plugin is responsible for deleting the lock file when a project goes IDLE (but only if the lock was created by the same project. Attributes. Attribute. Required. Descriptionlockfile. Yes. The name (and path) of the file to serve as the lock between multiple projects. Yes. Lockfile only deleted when contents match the value set for project name. The < bootstrappers> element is a container element.
Bootstrapper plugin instances. Bootstrappers are run before a build takes place, regardless of. Each bootstrapper element is independent of the others so it is quite. CVS or. Vss. Bootstrappers to update 3 different files. Child Elementstop. Automatically updates an accurev workspace. The selected workspace must already exist on the local filesystem.
Attributes. Attribute. Required. Descriptionkeep. No (defaults to "false")If true, the plugin runs "accurev keep - m" before trying to update the workspace, to keep all modified elements. No (defaults to "false")If true, the plugin runs "accurev synctime" before trying to update the workspace, to synchronize the local clock with the Accurev server's. No (defaults to "false")Enables detailed logging. No (defaults to the current dir)The local path containing the working copy of the desired workspace.
Examples. Updates the workspace locally stored on D: \accurev\workspace_user\My. Project. after synchronizing the local clock with the autokeeping all the modified files. D: \accurev\workspace_user\My. Project". synctime="true". Syncs a single path from Alien.
Brain before the build begins. Useful. if you want to leave all SCM up to Cruise.
Control. Allowing the. Attributes. Attribute. Required. Descriptionserver. No. The name of the machine hosting the Alien. Brain repository. If specified, it will override the value in the NXN_AB_SERVER environment variable. No. The name of the project in the Alien.
Brain repository. If specified, it will override the value in the NXN_AB_DATABASE environment variable. No. The Alien. Brain user account name to use when querying for modifications. If specified, it will override the value in the NXN_AB_USERNAME environment variable.
No. The password of the Alien. Brain user account to use when querying for modifications. If specified, it will override the value in the NXN_AB_PASSWORD environment variable. Yes. The path to the item that will be retrieved from Alien. Brain. Typically a path like 'alienbrain: //Project/Sub. Project/build. xml' If the path is a file, that file will be retrieved.
If the path is a directory, the directory will be retrieved recursively. No. The branch of the project from which to retrieve the path. No (defaults to false)If set to true, the local file is always updated with the file on the server. This is not the same as overwritewritable="replace".
It means that the file will be retrieved even if it has not been modified in the repository. No (defaults to 'skip')Must be either 'skip' or 'replace'. No. If localpath is specified the item is copied to the specified local path. Executes an Ant script which implements a custom bootstrapper. Attributes. The antbootstrapper uses the same attributes. Child Elements. The antbootstrapper supports the same set of. Examples. Invoke the ant.
D: \workspace\My. Project and the. ant build file as My. Project- nightlybuild. C: \Java\apache- ant- 1. D: \workspace\My. Project". buildfile="My. Project- nightlybuild.
For additional examples, please. Can be used to pull a single file (usually build.
Clear. Case prior to building. Attributes. Attribute. Required. Descriptionfile. Yes. The filename to writeview. Path. Nolocal path to the filetop.
Can be used to automate the start- up of Clear. Case. Views and VOBs prior to building in dynamic views. Attributes. Attribute. Required. Descriptionviewpath. Yes. A path into the dynamic view to start- up, i.
M: \someview\somevob\somepath (Windows) or. Linux/Unix). A path is specified rather than a view tag.
Cruise. Control property definition. No. A comma separated list of VOBs to mount, i.
VOB1,\VOB2" (Windows) or. VOB1,/vobs/VOB2" (Linux/Unix). Examples. Start the Windows view "j. VOBs "\J2. EE_Sources" and "\J2. EE_Binaries". < property name="dir.
M: \j. 2ee_bld\J2. EE_Sources\src"/>. J2. EE_Sources,\J2. EE_Binaries"/>.
Used to reconfigure a CM Synergy project or project hierarchy. Attributes. Attribute. Required. Descriptionccmexe. No. The name of the CM Synergy command line client. If not provided, the.
Windows). sessionfile. No. The session file used by the.
CM Synergy session information. If this attribute is. No. The session name of the CM Synergy session you wish to use.
This name. must appear in the session file. If not set, the plugin will attempt.
Yes. The project spec (two part name) of the project you wish to reconfigure. No. If set to true, all subprojects will also be reconfigured. Defaults to. true.
Examples. Reconfigure the "j. CM Synergy session named "j. Due to the nature of certain Synergy project types basing their reconfigure on baselines.
This bootstrapper works almost identically to the cmsynergybaselinepublisher. Attributes. Attribute.
Required. Descriptionccmexe. No. The name of the CM Synergy command line client. If not provided, the. Windows). sessionfile. No. The session file used by the. CM Synergy session information.
If this attribute is. No. The session name of the CM Synergy session you wish to use.
This name. must appear in the session file. If not set, the plugin will attempt. No. An optional name for the baseline. If not provided, CM Synergy will assign a default name based upon the current date. Yes. The project spec (two part name) of the project you wish to reconfigure.
No. An optional description of the baselinebuild. No. Value to specify for the build attribute of the baselinepurpose. No. Value to specify for the purpose of the baselinestate.
No. Value to specify for the state of the baseline. Valid values are. Default state is "published_baseline"Examples. Create a baseline called "test_baseline" for project "test_project_1~dev. System Testing", status "released" and build "QA4. Synergy session "cc_session". QA4. 32". purpose="System Testing".
Since there can be a reliance on the build. Allowing the bootstrapper. Attributes< cvsbootstrapper> requires at least one of its. Attribute. Required. Descriptionlocal. Working. Copy. No. Path (absolute or relative to Build Loop execution.
CVS module which contains. CVSBootstrapper will execute the update.
Defaults to Build. Loop execution directory. No. The CVSROOT. Not required if the current working directory.
Working. Copy attribute is. No. The file to update from CVS, relative to localworkingcopy. If not specified either the current working directory must be.
Working. Copy must be. Changes. No. If set to true the update command will include the - C option. Sticky. Tags. No. If set to true the update command will include the - A option. No. Sets the compression level used for the call to cvs, corresponding to the "- z" command line. When not set, the command line parameter is NOT included. Valid levels are 1 (high speed.
Handles updating from a darcs repository before the build. Attributes< darcsbootstrapper> requires at least one of its.
Attribute. Required. Descriptiondarcs. Binaryno (default "darcs")Name or location of the darcs binaryworkingdir. At least one of workingdir or repository location. Relative or absolute path to the workingdir. Directory must exist. Specifies the location of the Darcs repository to pull into.
Repository. Locationno. Specifies the location of the remote Darcs repository to pull from.
Usually. the local repository already knows about this. Handles updating from a git repository before the build. Attributes. Attribute. Required. Descriptionlocal. Working. Copy. Yesthe relative or absolute path to the local working copy of.
Since there can be a reliance on the build. Allowing the bootstrapper. In order to use this element, you must have the All.
Fusion Harvest. client installed on the Cruise. Control machine. Additionally, the.
HARVESTHOME environment variable should be set (this. All. Fusion Harvest). And you'll. need to build the plugin.
The jar you'll need to build the plugin is jhsdk. Harvest installation.
To build the plugin read the directions for Building. Plugins That Need External Libraries. Attributes< harvestbootstrapper> requires at least one of its. Attribute. Required. Descriptionusername. Yes. Usename to use in connecting to the Harvest Broker.
Yes. Password to use in connecting to the Harvest Broker. Yes. The name of the Harvest Broker to connect to.
Yes. The name of the project containing the file you wish to. Can be different from the cruisecontrol project. Yes. The name of the state containing the file you wish to bootstrap. Yes. The Harvest view path of the file you wish to bootstrap. Yes. The Harvest client path to use when checking out the bootstrap file.
Yes. The name of the Harvest checkout process to use. Yes. The name of the file to be bootstrapped. No. The item filter to use.
One of: baseline. Default is. both. No. The version filter to use. One of: latest_in_view. Default is latest_in_view.
No. The status option to use. One of: all. no_tag, reserved, merged. Default is. all. branch. No. The branch option to use. One of: trunk. branch, trunk_and_branch.
Default is trunk. This plugin works in conjunction with a < lockfilelistener> to define a set of projects that will not build simultaneously in a multithreaded build environment.
This plugin is responsible for creating the lock file if it doesn't already exist, or if it does, to throw an exception to abort the build attempt. When a build attempt is aborted the project will not be retried until the next build time as determined by the schedule interval or the schedule build time. Attributes. Attribute. Required. Descriptionlockfile. Yes. The name (and path) of the file to serve as the lock between multiple projects. Yes. The project name is written to the lockfile so that the Lock.
File. Listener knows which to delete. Handles updating from a Mercurial repository before the build. Attributes. Attribute. Required. Descriptionlocal. Working. Copy. Yesthe relative or absolute path to the local working copy of.
Mercurial repository on which to execute the update. Syncs a single path from Perforce before the build begins. Useful. if you want to leave all SCM up to Cruise.
Control. Allowing the. Setting the path to a complete P4 depot ending with a typical. Note that the attributes path, p. Port, p. 4User, and p. Client are deprecated. Please use the attributes listed below. Attributes. Attribute.
Required. Descriptionview. Yes. Valid Perforce path (a. No. Perforce Server connection to use (host: port)user. No. Perforce User name to usepasswd.
No. Perforce password to useclient. No. Perforce Client name to usetop. Automatically updates the workspace before the build begins. The selected workspace must already exist on the local filesystem. Attributes. Attribute. Required. Descriptionwkspath.
Yes. Valid Plastic SCM workspace path. No. The branch from which to get the source. If none has been specified, it updates the workspace according to its configuration. No. The repository from which to get the source. If none has been specified, it updates the workspace according to its configuration. No. A path under the workspace path which will be updated.
If none is specied, it updates all the workspace. No (defaults to "false")Do the update with the "- -forced" option. Examples. Update the workspace (using the option forced) in the path in c: \work\cruise\plasticwks setting the branch "br: /main" as working branch. Can be used to pull a single file (usually build. Snapshot. CM prior to building.
Attributes. Attribute. Required. Descriptionfile. Yes. Name of the file or directory to fetch from the Snapshot. CM. repository. Updates from Snapshot. CM repository will be.
Handles updating multiple files (space separated list) from Star. Team. before the build begins. To use this plugin you'll need to build it. The jar you'll need to build the plugin is starteam- sdk.
To build the plugin read the directions for Building. Plugins That Need External Libraries. Attributes. Attribute. Required. Descriptionfiles. Yes. Space separated list of files to retrievefolder. Yes. The repository folderlocalfolder.
No. Path to the folder on the local file systempassword. Yes port. Yes. Port Star. Team server is usingproject. Yes. Star. Team projectserver. Yes. Hostname for Star. Team serverusername. Yes view. Yes. Star.
Team viewtop. Fetches a single repository (and optionally it's sub- repositories). Surround SCM before starting the build. Attributes. Attribute. Required. Descriptionbranch.
No. Surround SCM branch name. The default is pulled from the local working directory. No. Surround SCM repository path. The default is pulled from the local working directory. No. Enter a label to search for when getting files.
No. Include removed files when getting files by label or timestamp. Default is true. Ignored if a label is not specified. Options are 1 or 0 (default). No. Enter how to handle a local writable file. Options are 1 to overwrite or 0 (default) to skip. No. Recursively get files and sub- repositories. Options are 1 or 0 (default).
No. Force file retrieval from server regardless of the local copy status. Options are 1 or 0 (default). No. Make local file editable or writable. Default is read- only. Options are 1 or 0 (default). No. Enter the address and port number of the Surround SCM server host computer.
Format is server: port. If not entered, the last saved connection parameters are used. No. Enter the username and password used to login to the Surround SCM server. Format is username: password. If not entered, the last saved login parameters are used. Handles updating a single file (typically build. Subversion repository before the build.
Attributes. Attribute. Required. Descriptionlocal. Working. Copy. One of thesethe relative or absolute path to the local working copy of. Subversion repository on which to execute the update.
Subversion repository. Noused for authentication. Noused for authentication. Dir. No. Instructs Subversion to read configuration information from the specified directory instead of the default location (. Gets a single path from Visual Studio Team Foundation Server before the build begins. Gets are performed by calling out to the TFS command line (tf).
Microsoft provide the tf. Team Explorer client installation on Windows platforms.
For. information on obtaining the Microsoft Team Explorer client, visit. Code. Plex wiki. Teamprise also provide a tf command that works cross- platform including.
GNU/Linux, Mac, MP- UX and Solaris platforms as well as Windows. To download the. Teamprise command line client, visit the. Teamprise download site. Note that the Teamprise client requires activation when using it with a. Teamprise Knowledgebase.
Gets are performed by executing a command similar to the followingtf get //build/path/to. DOMAIN\name,password. For further details regarding the tf get command, consult the. MSDN documentation. Setting the path to a folder and setting the recursive option to true will get all. This is useful if you want to leave the SCM. Cruise. Control. Allowing the bootstrapper to perform a get latest does make.
For this to work, you must have an existing TFS workspace created for the user on the build server. For example, in the case where the project location is. TFS at. $/My. Team. Project/trunk you would have first needed to execute.
DOMAIN,password /new build. Workspacetf workfold /server: http: //tfsserver: 8.
DOMAIN,password /workspace: build. Workspace /map $/My. Team. Project/trunk //cruisecontrol/projects/myproject. If you would like gets to be performed using a TFS Version Control Proxy and you are using the Microsoft tf. TFSPROXY (for example set TFSPROXY=http: //tfsproxy: 8. If you are using the Teamprise command line client, then you may pass "- proxy: http: //tfsproxy: 8. Attributes. Attribute.
Required. Descriptionitem. Spec. Yes. The path to perform a get for. This may be a local or server path as defined by the Item Specification. For more information on valid item specification see http: //msdn. VS. 8. 0). aspx#section. Toggle. 3usernameno. The username to use when connection to Team Foundation.
Server. This user must have read permissions to the. Path. When using. Microsoft client, if no username is passed then the user. Cruise. Control process is running as will be used.
Note that is a username is provided then a password must be. The username should be passed in the form DOMAIN\username. From unix systems the name can be passed in the username@DOMAIN.
It is possible for the command line client to determine the credentials automatically. Microsoft command line client. The password to use with the username when authenticating. Path. No (defaults to "tf")Specify the full path to the tf command being used. If. By default. the Microsoft client is installed into C: \Program Files\Microsoft Visual Studio 8\Common.
IDE\TF. exerecursiveno (defaults to false)Flag to indicate if a recursive get should be performed. Flag to indicate of the tf get command should be performed using the /force. By default, TFS will only download files that the server thinks have. TFS workspace. It will also not overwrite locally writable. Setting the force option will make TFS always download the files and.
An optional string that may be passed as part of the command. The contents of the options tag are passed as an. Handles updating a single file (typically build. VSS before the build begins. Attributes. Attribute.
Required. Descriptionvsspath. Yes. Fully qualified VSS path to the target file. If the leading. dollar- sign ['$'] is omitted, one will be prepended. Example: /Project/subproject/filename. Yes. Fully qualified path for the destination directory. Example: c: \directory\subdirectory\login. No. VSS login information in the form username,passwordssdir.
No. Path to the directory containing ss. By default, ss. exe. Note: should not contain whitespace.
No. Path to the directory containing srcsafe. A container element for a set of modifications collected from all.
Source. Control elements. Most Source. Control elements support the property. On. Delete attributes which can allow for. Attributes. Attribute.
Required. Descriptionrequiremodification. No (defaults to true)Is a modification required for the build to continue? Default value is true. Useful to set to false when the schedule. NOTE - This attribute. Use the require. Modification attribute that is on the.
No (defaults to 6. The number of seconds required to have passed since the last. This attribute is used.
If a. modification is detected to be within the quiet period then CC. Small values recommended if you use a. Perforce and Subversion with atomic commits. Files. No. Specify a comma separated list of glob- patterns identify files to be ignored in modificationsets. Each pattern is matched against the complete path. Example: *. txt,*/build/build. This is useful if you want to update and commit files during your CC build.
Child Elements. Element. Cardinality. Description< accurev> 0 .
Checks for changes in an Accu. Rev stream.< alienbrain> 0 . Checks for changes in an Alien.
Brain repository.< alwaysbuild> 0 . Always returns a single modification so the build will be run.< buildstatus> 0 . Checks for a successful build in another project.< clearcase> 0 . Checks for changes in a Clear.
Case repository.< cmsynergy> 0 . Checks for changes in a CM Synergy repository.< compound> 0 . Checks for changes from a list of trigger source controls. Checks for changes in a CVS repository.< darcs> 0 . Checks for changes in a Darcs repository.< filesystem> 0 .
Checks for changes in a file system.< forceonly> 0 . Never returns any changes. Deprecated: use forceonly attribute on < project> instead.< git> 0 .
Checks for changes in a git repository.< git> 0 . Checks for changes in a git repository.< harvest> 0 . Checks for changes in an All Fusion Harvest repository.< httpfile> 0 . Checks for changes in a remote file via http.< mercurial> 0 . Checks for changes in a Mercurial repository.< mks> 0 .
Checks for changes in a MKS repository.< p. Checks for changes in a Perforce repository.< plasticscm> 0 .
Checks for changes in a Plastic SCM branch.< pvcs> 0 . Checks for changes in a PVCS repository.< snapshotcm> 0 . Checks for changes in a Snapshot. CM repository.< starteam> 0 . Checks for changes in a Star Team repository.< store> 0 . Checks for changes in a Cincom Smalltalk Visual.
Works. Store repository.< surround> 0 . Checks for changes in a Surround SCM repository.< svn> 0 . Checks for changes in a Subversion repository.< tfs> 0 . Checks for changes in a Microsoft Visual Studio Team Foundation Server repository.< timebuild> 0 . Triggers a build after a particular time threshold.< veto> 0 .
Checks for changes in another project and will veto a build if changes are found.< vss> 0 . Checks for changes in a Visual Source. Safe repository.< vssjournal> 0 . Checks for changes in a Visual Source. Safe, Journal File. Implementation. top. Checks for modifications in an Accu.
Rev stream. Attributes. Attribute. Required. Descriptionstream.
Yes. The name of the Accu. Rev stream where the plugin looks for Modification(s). No (defaults to "false")Set to "true" to enable a more verbose logging style. No. Will set this property if a modification has occurred. For. use in conditionally controlling the build later. Triggers a build if there is a change in an Alien.
Brain repository. Changes are detected by running a command similar to the following: ab find Path. To. Project - regex "SCIT > lastbuildtime" Attributes. Attribute. Required. Descriptionserver. No. The name of the machine hosting the Alien. Brain repository.
If specified, it will override the value in the NXN_AB_SERVER environment variable. No. The name of the project in the Alien. Brain repository. If specified, it will override the value in the NXN_AB_DATABASE environment variable. No. The Alien. Brain user account name to use when querying for modifications. If specified, it will override the value in the NXN_AB_USERNAME environment variable. No. The password of the Alien.
Brain user account to use when querying for modifications. If specified, it will override the value in the NXN_AB_PASSWORD environment variable. Yes. The path to the item that will be queried for modifications Typically a path like 'alienbrain: //Project/Sub. Project'branch. No. The branch of the project to check for modifications.
No. Will set this property if a modification has occurred. For. use in conditionally controlling the build later. Used to always trigger a build by returning a single modification. Attributes. Attribute. Required. Descriptionusername. No (defaults to "User")The username to use for the single reported (fake) Modification. No. Set this property if a modification has occurred.
For use in conditionally controlling the build later. Used to trigger a build when another Cruise. Control project has a.
When triggered, this will report a modification. You may need make an. Attributes. Attribute. Required. Descriptionlogdir. Yes. Path to Cruise. Control log directory for the project to.
No. Will set this property if a modification has occurred. For. use in conditionally controlling the build later. If. Failing. No. Will abort the build attempt if the last build of the monitored project is failing. Defaults to false. Properties Passed to the Builders. In addition to the standard Cruise. Control. properties passed to builders, < buildstatus> sets the.
Property Name. Descriptionmost. The location being checked for new log filesmost. The name of the newest logfile included in the. The timestamp of the newest build included in the. MMdd. HHmmssmost. The label of the newest build included in the. Triggers a build if there is a change within a Clear.
Case repository. Attributes. Attribute. Required. Descriptionbranch. Yes. The Clear. Case branchrecursive.
No (defaults to true)Whether to check sub- folders in the viewpath. No (defaults to false)Set when checking the entire view path. When checking the entire view path this option invokes 'lshistory - all'. This option is mutually exclusive with the recursive property. Note that 'all' does not use your view's config- spec rules. It behaves. like having a single line config- spec that selects just ELEMENT * /< branch> /LATEST.
This differs from. Yes. Local working copy to use when making queriesproperty. No. Will set this property if a modification has occurred. For. use in conditionally controlling the build later.
Properties Passed to the Builders. In addition to the standard Cruise. Control. properties passed to builders, < clearcase> sets the. Property Name. Descriptionclearcaselastbuild.
Timestamp representing the last built time, using the. MMMM- yyyy. HH: mm: ssclearcasenow. Timestamp representing the time the current build. MMMM- yyyy. HH: mm: sstop. Triggers a build if tasks have been added to any folder within a. CM Synergy project's reconfigure properties since the last build. If used to check for modifications to a System Testing or.
Insulated Development project, this will also check for any. Attributes. Attribute. Required. Descriptionccmexe. No. The name of the CM Synergy command line client. If not provided, the. Windows). sessionfile.
No. The session file used by the. CM Synergy session information. If this attribute is.
No. The session name of the CM Synergy session you wish to use. This name. must appear in the session file. If not set, the plugin will attempt. Yes. The project spec (two part name) of the CM Synergy project in which. No. Used to set the project's instance value. As CM Synergy only allows a. You. might, however, need to set this value when using the DCM (Distributed.
Change Management) feature of the tool - which appends the DB name to. No. The default (output) date format used by CM Synergy is. EEE MMM dd HH: mm: ss yyyy" If you have customized this for your installation.
The format should follow the. Java's Simple. Date. Format class. updatefolders. No. By default, the plugin will always refresh the reconfigure properties of.
This allows any query. If you wish to disable. This feature will only work with CM Synergy version 6. If. you are using an older version, you must set this option to false. In this. case, you'll want to use the.
Please see example 2 below as well as the Wiki site for. No. Disabled by default. If you set this option to true, the project (and. This eliminates the need to handle this from within your build. No. Used in conjunction with the reconfigure option. If set to true (which is. No. If set to true, the time a task came into the reconfigure folder is used.
This is. a more precise query to find modifications since the last build when the. Change. Synergy change request. This feature will only work with CM Synergy version. SP1 and above. If you are using an older version, you must set this. No. By default, the plugin will query CM Synergy to determine the work area.
This location is then passed to the builders in. If you wish to disable this feature. No. If provided, an active link will be created from. The format should be. If you wish to use this option.
No. Used in conjunction with changesynergyurl. This. should be set to the location of the database on. CM Synergy server. No. If you have a non U. S. English installation of CM Synergy, you may.
ISO language code here. No. If you have a non U. S. English installation of CM Synergy, you may. ISO country code here. FR, DE, etc.)property. No. Added for compliance with the Cruise.
Control API. A property of. CM Synergy. object has changed since the last build. The default is. cc. Properties Passed to the Builders. In addition to the standard Cruise. Control. properties passed to builders, < cmsynergy> sets the.
Property Name. Descriptioncc. The CM Synergy session ID used to check for modifications. The date format used to convert CM Synergy dates into Java dates. The two part name of the project (as provided in the project attribute). The file system location of the CM Synergy work area for the project. Set to true if any CM Synergy objects have changed since the last build. Examples. Use the session named "j.
If any changes are detected, reconfigure the. For users of CM Synergy older than version 6. Use the. < cmsynergybootstrapper>. This will. update the folders within that project's reconfigure properties. We can then check for changes just as we did in the first example.
Notice that we must set the "updatefolder" attribute to false. Contains two separate lists of source controls. Triggers. are checked for modifications every scheduled poll. Targets are. only checked for modifications if there was any modifications detected. Arbitrary nesting of source controls under < triggers>. The < compound> element allows optimized access to. A typical usage scenario is to configure the source.
In addition to the modifications returned by the target source. If. include. Trigger. Changes is set then the properties returned by the. Attributes. Attribute. Required. Descriptioninclude. Trigger. Changes. No (defaults to false)Add the trigger modifications to the list of returned.
By default, the list of returned modifications. By setting this attribute. No. Set this property if a modification has occurred.
For use. in conditionally controlling the build later. Child Elements. Element. Cardinality. Description< triggers> 1. A container for one or more source control elements that.
Any child element of. A container for one or more source control elements that. Any child element of. Example. This example polls the file mod_file. When a change. is detected, < cvs> is used to.
If mod_file. txt. Trigger. Changes="false">. Triggers a build if there is a change within a CVS repository. Changes are detected by running a command similar to the following: cvs [- d CVSROOT] - q log|rlog [- N] - d "lastbuildtime< checktime" [- b|- r. TAG] module. The following changes are made to generate the actual command: log is used when the localworkingcopy attribute is set. MM- dd HH: mm: ss 'GMT'. The - d option is only used when the cvsroot.
CVSROOT is replaced by. The - r option is only used when the tag attribute. TAG is replaced by the value of. Otherwise, the - b option is used. The - N option is only used when the tag attribute. HEAD. module is replaced with the specified module. If a local working copy is used then the module name is.
Refer to the cvs log reference for. A notable feature of the CVS element is that it will look for the. CVSROOT/users and, if the files exists, use the information in. More details are on. CVSROOT/users page of the Cruise.
Control Wiki. Attributes. Attribute. Required. Descriptionlocalworkingcopy. Either localworkingcopy or both cvsroot. Relative or absolute path to the local working copy. Directory must exist and should have files from a previous.
Specifies the location of the CVS repository. This should. be of the form: pserver: username@cvs. The name of the CVS module that should be used. This is passed as the last parameter to the cvs rlog command.
Refer to the rlog command in the. No (defaults to HEAD)Specify the cvs tag. The value of this attribute is passed.
Numeric revision numbers, tags, branch tags, or ranges of. Refer to the - r option in the. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. No. Set this property if a file has been deleted. For use in. conditionally controlling the build later.
Quiet. No. Sets whether to use "- Q", instead of the default "- q" for the cvs log command. Setting this. attribute to true can help to reduce Cruise. Control log file size, especially when using branches. Defaults to false. Local. Working. Copy.
No. Sets the behavior when a local working coppy is set which is not under control of CVS itself. CVS subdirectory). If set to true all subdirectories are searched recursively. All subdirectories which are under control of CVS are searched for modifications in the usual manner. Defaults to false. No. Sets the compression level used for the call to cvs, corresponding to the "- z" command line. When not set, the command line parameter is NOT included.
Valid levels are 1 (high speed. Emails. Fetching. No (defaults to false)If set to true, fetching of CVSROOT/users is skipped. Triggers a build if there is a change within a Darcs.
Attributes. Attribute. Required. Descriptionworkingdir. Either workingdir or repository location. Relative or absolute path to the workingdir.
Directory must exist. Specifies the location of the Darcs repository. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later.
No. Set this property if a file has been deleted. For use in. conditionally controlling the build later. Returns all files beneath the specified path than have been. Any modified files are reported as. User". Can also have folder. Only looks at timestamp, not for actual changes. If includedirectories is set it detects changes to directory.
Attributes. Attribute. Required. Descriptionfolder.
Yes. Root folder of the directories to scan, or path to file to. No. Include modified directories. Defaults to false. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later.
No (defaults to "User")The username to use for the reported Modifications. Deprecated. Use forceonly attribute on < project> instead. Never returns any changes. Use this to define a project that.
If you also want the modifications between two forced builds to. Attributes. Attribute. Required. Descriptionproperty.
No. Set this property if a modification has occurred. For use. in conditionally controlling the build later.
Checks for changes within a git repository. Attributes. Attribute. Required. Description. Local. Working. Copy. Yes. Relative or absolute path to the local working copy of the.
No. Set this property if a modification has occurred. For use. in conditionally controlling the build later.
No. Set this property if a file has been deleted. For use in. conditionally controlling the build later. Properties Passed to the Builders.
In addition to the standard Cruise. Control. properties passed to builders, < git> sets the. Property Name. Descriptiongitcommitid.
The commit id of the latest committop. Triggers a build if there is a change within an All.
Fusion Harvest. repository. Can be set to monitors for either new versions being. In order to use this element, you must have the All. Fusion Harvest. client installed on the Cruise.
Control machine. Additionally, the. HARVESTHOME environment variable should be set (this. All. Fusion Harvest) and you'll.
The jar you'll need to build the plugin is jhsdk. Harvest installation. To build the plugin read the directions for Building. Plugins That Need External Libraries. See the All. Fusion. Harvest product page for more information.
This implementation has only been tested against All Fusion Harvest. Attributes. Attribute. Required. Descriptionusername.
Yes. The username to connect as. Yes. The password to connect with. Yes. The name of the Harvest broker to connect to.
Yes. The state in which you want to search for changes. No. The state in which you want to search for demotion changes.
Only used if mode is set to package. No. The Harvest view path within which to limit the search. Yes. The name of the project in All. Fusion Harvest that you want. Note that this can be different than the. Cruise. Control project name. No. The item filter to use.
One of: baseline. Default is. both. No. The version filter to use. One of: latest_in_view. Default is latest_in_view. No. The status option to use. One of: all. no_tag, reserved, merged.
Default is. all. branch. No. The branch option to use. One of: trunk. branch, trunk_and_branch.
Default is trunk. No. The mode to use for searching. One of: version. package. Default is. version.
No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. No. Set this property if a file has been deleted. For use in. conditionally controlling the build later. Checks a single file on a web server supporting modification dates. Apache). Intended to be used in a Compound modification set as.
Trigger. Attributes. Attribute. Required. Descriptionurl. Yes. The HTTP URL of a file to check the modification date ofusername.
No (defaults to "User")The username to use for the reported Modification. No. Set this property if a modification has occurred.
For use. in conditionally controlling the build later. Triggers a build if a Maven snapshot detects a change.
Attributes. Attribute. Required. Descriptionproject. File. Yes. Maven POM file. Yes. The username to use when reporting modifications. Repository. No. Local Maven JAR repository.
Defaults to {user. File. No. Sets the . POM. Default is build. No. Set this property if a modification has occurred. For use in conditionally.
Triggers a build if a Maven. Attributes. Attribute. Required. Descriptionpomfile. Yesmaven. 2 POM file. Yes. The username to use when reporting modifications. Repository. No (Not available until after maven v. Local Maven. 2 JAR repository.
Defaults to {user. No. Set this property if a modification has occurred. For use in conditionally. Triggers a build if there is a change within an MKS repository. Has the following prerequisites: The sandbox must always exists.
The MKS sourcecontrol are unable to create the sandbox for you. In principle, this is not a real problem as long as the underlying MKS command si are able to handle such a task, but in this initial version I don't create a sandbox during runtime. If you not always create your sandbox, see si createsandbox for more information. You have already logged in into the MKS Server. This should be done in your bootstrap section by the ANT task siconnect. The underlying java class is situated in the mksant. MKS Customer Community.
Since this (and the corresponding sidisconnect) anttasks are only small wrapper for the command line call of si, this could be done in later versions by the MKS sourcecontroller itself. You should call the sidisconnect task after your build, e.
Attributes. Attribute. Required. Descriptiondo.
Nothing. No. If this attribute is set to true, no mks command is executed. This is for testing purposes, if a potentially slow MKS server.
Yes. Local directory for the sandbox. Yes. The name of the MKS project file (mostly project.
No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. Triggers a build if there is a change within an Mercurial repository. Attributes. Attribute. Required. Descriptionlocal. Working. Copy. Yes. Local directory for the sandbox.
No. The hg command used to check changes. Either 'incoming' or 'log'. Default is 'incoming'Properties Passed to the Builders. In addition to the standard Cruise. Control. properties passed to builders, < mercurial> sets the.
Property Name. Descriptionhgrevision. The latest revision numbertop. Triggers a build if there is a change within an Perforce repository.
Attributes. Attribute. Required. Descriptioncorrect. For. Server. Time.
No. Should Cruise. Control correct for time differences between the Perforce server and the Cruise. Control server? Defaults to true. Yes. Perforce Server connection to use (host: port)client. Yes. Perforce Client name to useuser.
Yes. Perforce User name to usepasswd. No. Perforce password to useview. Yes. Valid Perforce view (i. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. No. Should the Email address for the users be retrieved from Perforce if possible. Defaults to true.
Checks for changes in a Plastic SCM repository. Attributes. Attribute. Required. Descriptionwkspath. Yes. Valid Plastic SCM workspace path. Yes. The branch in which changes will be looked for. No. The repository in which changes will be looked for.
Examples. Used to check for changes in the branch br: /main. Checks for changes in a PVCS repository. Attributes. Attribute.
Required. Descriptionarchivefilesuffixno. Standard suffix for archive set when the repository is created. Default value is "- arc".
Used to supply a user and password. Example: loginid="sampleuser: samplepassword" or loginid="sampleuser"pvcsproject. Yes. Project name. Yes. Subproject name. No. Path to directory with pcli.
No. The version label for the PVCS builder to check against. Example: pvcs. Version. Label="Sample. Version. Label"pvcspromotiongroup. No. The promotion group for the PVCS builder to check against. Example: pvcspromotiongroup="Sample.
Group"outdateformat. No (defaults to "MMM dd yyyy HH: mm: ss")The format to use to parse the Last. Modified entry as.
No (defaults to "MM/dd/yyyy hh: mm: ss aa")The format used to format the lastbuild date for pvcs commands. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. Checks for changes in a Snapshot.
CM repository. Attributes. Attribute. Required. Descriptionsourcepaths. Yes. A semi- colon- separated list of source paths to check. All paths will be checked recursively. No. Property to be set if a modification has occurred.
For use. in conditionally controlling the build later. No. Property to be set if a file has been deleted. For use in. conditionally controlling the build later. Checks for changes in a Star Team repository. If logged on as SERVER ADMINISTRATOR it will look up the email. To use this plugin you'll need to build it. The jar you'll need to build the plugin is starteam- sdk.
To build the plugin read the directions for Building. Plugins That Need External Libraries. Attributes. Attribute. Required. Descriptionfolder.
Yes. The repository folderpassword. Yes. Password for the Star. Team userstarteamurl. Yesusername. Yes. Star. Team user namepreload.
File. Information. No (defaults to true)When set to true can make the modification check much. No. Property to be set if a modification has occurred. For use. in conditionally controlling the build later. No. Property to be set if a file has been deleted. For use in. conditionally controlling the build later. Checks for changes within a Cincom Smalltalk Visual.
Works. Store repository. In order to use this element, you must set up a script or. Visual. Works Smalltalk image with. Cruise. Control package loaded. The image must be configured.
Cruise. Control package itself. The latest version of the Cruise.
Control package is. Cincom. Public Store Repository.
Attributes. Attribute. Required. Descriptionworking.
Directory. Yes. Relative or absolute path to the directory in. Store script. script. Yes. The name of the script to run to access the Store repository. The script should launch a Visual. Works Smalltalk image with the.
Cruise. Control package loaded. The image must be configured so. Cruise. Control package itself. Yes. The name of the Store connection profile for the repository. Yes. A comma- separated list of package names.
These packages and. Regex. No. A Regex. Only package versions that.
By default, all. package versions are considered. Blessing. Level. No. A Store blessing level string. Package versions with a lower. Default: Development. Builder. File. No.
Relative or absolute path to a file which will contain a list of. By default, no parcel builder file will be created. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. Attributes. Attribute.
Required. Descriptionbranch. No. Surround SCM branch name. The default is pulled from the local working directory. No. Surround SCM repository path. The default is pulled from the local working directory.
No. Enter a file or repository name or a searchable pattern. Can be / or empty, which means the repository specified by the repository option or the default repository. No. If set to 1, the file parameter will be interpreted as a regular expression. Options are 1 or 0 (default). No. Recursively check files and sub- repositories.
Options are 1 or 0 (default). No. Enter the address and port number of the Surround SCM server host computer. Format is server: port.
If not entered, the last saved connection parameters are used. No. Enter the username and password used to login to the Surround SCM server. Format is username: password.
If not entered, the last saved login parameters are used. No. Set this property if a modification has occurred.
For use. in conditionally controlling the build later. Checks for changes within a Subversion repository. Attributes. Attribute.
Required. Description. Local. Working. Copy.
One of these. Relative or absolute path to the local working copy of the. Subversion repository of which to find the log history. Repository. Location. The url to the Subversion repository on which to find the. Noused for authentication. Noused for authentication.
Dir. No. Instructs Subversion to read configuration information from the specified directory instead of the default location (. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. No. Set this property if a file has been deleted. For use in. conditionally controlling the build later. Externals. No. Whether any subversion externals this project uses should also.
Local. Revisionfalse. Optionally allows the user to get the modifications made between the last build time and the localworkingcopy's revision number.
Properties Passed to the Builders. In addition to the standard Cruise. Control. properties passed to builders, < svn> sets the. Property Name. Descriptionsvnrevision. The repository revision numbertop. Triggers a build if there is a change within a Microsoft Visual Studio Team Foundation Server (TFS) repository.
Changes are detected by calling out to the TFS command line (tf). Microsoft provide the tf. Team Explorer client installation on Windows platforms. For. information on obtaining the Microsoft Team Explorer client, visit Code.
Plex wiki. Teamprise also provide a tf command that works cross- platform including. GNU/Linux, Mac, MP- UX and Solaris platforms as well as Windows. To download the Teamprise command line client, visit the Teamprise download site (fully functional evaluation licenses are available). Note that the Teamprise client requires activation when using it with a. Teamprise Knowledgebase. Changes in TFS are detected by running a command similar to the following: tf history $/Team. Project. Name/path. D2. 00. 6- 1. 2- 0.
T0. 1: 0. 1: 0. 1Z~D2. T2. 0: 0. 0: 0. 0Z. DOMAIN\name,password. For further details regarding the tf history command, consult the MSDN documentation. It is worth noting that this implementation of integration with TFS.
Microsoft tf. exe and the Teamprise tf command line. There are some small. Attributes. Attribute.
Required. Descriptionprofile. One of these. Name of the profile to set. Supported by the Teamprise client. URL to access the Team Foundation Server including port, for. Pathyes. Path in the TFS repository that is.
Any changes under. Path. No (defaults to "tf")Specify the full path to the tf command being used. If. By default. the Microsoft client is installed into C: \Program Files\Microsoft Visual Studio 8\Common. IDE\TF. exeinput. Encoding. No (defaults to UTF- 8)Required if file names or comments contains non- Latin symbolsusernameno. The username to use when connection to Team Foundation. Server. This user must have read permissions to the.
Path. When using. Microsoft client, if no username is passed then the user. Cruise. Control process is running as will be used.
Note that is a username is provided then a password must be. The username should be passed in the form DOMAIN\username. From unix systems the name can be passed in the username@DOMAIN format if preferred as that removes confusion over escaping of. The password to use with the username when authenticating. An optional string that may be passed as part of the command. The contents of the options tag are passed as an.
Properties Passed to the Builders. In addition to the standard Cruise.
Control properties passed to builders, < svn> sets the. Property Name. Descriptiontfschangeset. The maximum changeset number in the modifications detectedtop. Triggers a build after a particular time threshold. This will return a. Once a successful build occurs, no more modification.
Attributes. Attribute. Required. Descriptionusername.
No (defaults to "User")The username to use for the single reported (fake) Modification. Yes. The threshold time to cross that starts triggering a build, specified.
No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. Triggers a build if there is a change within a Clear. Case UCM repository.
Attributes. Attribute. Required. Descriptionstream.
Yes. The Clear. Case UCM stream (actually, the branch, so make sure to. UCM stream)rebases. No (defaults to false)Whether rebases of the integration stream are reported as changes. No (unless rebases is true)The name of the pvob to use for queries. Required if rebases = true.
Required if multi. Vob is true and the pvob for the project is not loaded. No (defaults to true)Whether to check for and log contributor activitiesviewpath. Yes. Local working copy to use when making queriesproperty. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. Vob. No. Set whether the view contains multiple vobs.
Defaults to false. Properties Passed to the Builders.
In addition to the standard Cruise. Control. properties passed to builders, < ucm> sets the following. Property Name. Descriptionucmlastbuild. Timestamp representing the last built time, using the format dd- MMMM- yyyy. HH: mm: ssucmnow. Timestamp representing the time the current build started, using.
MMMM- yyyy. HH: mm: sstop. This plugin is designed to help enforce build order between dependent projects.
It will check to see if a project is up to date and vetos the build attempt if it is not. Veto is configured by defining a nested set of sourcecontrols and a buildstatus element. If project bar depends on project foo then bar may have a < veto> with triggers that are the same as the modificationset for foo and a < buildstatus> that points to the logs for foo. If there is a change that would cause foo to build but bar is first in the build queue, then the < veto> in bar will detect that foo is out of date and abort the build attempt by throwing an exception. Unlike most source controls, Veto never returns any modifications. Its only job is to abort builds when another project is out of date with respect to some set of modifications.
Child Elements. Element. Cardinality. Description< triggers> 1.
A container for one or more source control elements that. Any child element of. Points at the logs for the project that is checked to see if it is up to date with the modifications detected by the < triggers>. Example. In this if there are changes in the cvs repository for foo since the last time project foo built successfully then the veto will throw an exception and abort the build attempt. If there are no changes in the repository for foo or project foo is up to date then < veto> will do nothing and the build attempt will continue as normal (building if there are modifications detected in the reposiotry for bar).< modificationset>. Checks for changes in a Visual Source.
Safe repository. Attributes. Attribute. Required. Descriptiondateformat.
No (defaults to default is MM/dd/yy)The date format to use for querying VSS and processing. If your computer is set to a different region, you.
MM/yy. timeformat. No (default is hh: mma)The time format to use for querying VSS and processing. If your VSS is configured differently you may need a. HH: mm: ss. vsspath. Yes. The VSS project to get history from. Example: /Project/subprojectlogin.
Yes. The VSS login to use, in the form. No. Path to the directory containing ss.
By default. ss. exe is assumed to be in the path. Note: should not contain whitespace. No. Path to the directory containing srcsafe.
No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. No. Set this property if a file has been deleted. For use in. conditionally controlling the build later. Checks for changes in a Visual Source. Safe repository. This implementation doesn't require the source safe executable making.
Windows machines. Attributes. Attribute.
Required. Descriptionjournalfile. Yes. Full path to journal file. Example: c: /vssdata/journal/journal.
Yes. The VSS project to get history fromproperty. No. Set this property if a modification has occurred. For use. in conditionally controlling the build later. No. Set this property if a file has been deleted. For use in. conditionally controlling the build later. Cruise. Control allows the user to schedule an arbitrary. Builds will only run if modifications are.
JMX interface, or the < project> has. Modifications set to false. Because of. this it is usually not a good idea to mix time builds and.
Note: Only one builder is used for a given interval. Builds using the time attribute take. If. no matching time builds are found the multiple builds are. If there are multiple Builders with the same.
Attributes. Attribute. Required. Descriptioninterval. No. Interval period in seconds. Default value is 3. Maximum value is 3. Cruise. Control the maximum practical.
Minimum value is 1. Zero and. negative values are not allowed. Ignored if schedule only has time. Progress. No (defaults to true)If true or omitted, the scheduled builder will provide progress messages if the builder supports this. Progress setting is not false.
If false, no progress messages will be shown - regardless of the scheduled builder's. Progress setting. Child Elements. Element. Cardinality. Description< ant> 0 . Builds the project using Ant.< composite> 0 .
Executes a list of builds.< maven> 0 . Builds the project using Maven.< maven. Builds the project using Maven. Pauses the build.< nant> 0 . Builds the project using NAnt.< phing> 0 .
Builds the project using Phing.< rake> 0 . Builds the project using Rake.< exec> 0 . Builds the project using the Exec. Builder.< pipedexec> 0 . Builds the project using the Piped. Exec. Builder.< xcode> 0 . Builds the project using Apple's Xcode IDE.
Attribute. Required. Description. No. Build index used to run different builders. For example. if this is set to 3, the builder will be run every 3 builds. Default value is 1. Can't be set if time is set.
No. Time in the form HHmm. Can't be set if multiple is set. No. Valid values are (case- insensitive) the English names for. Sunday, Monday, Tuesday, etc). Does not. support multiple days except for the default of every day.
No (defaults to true)If true, the builder will provide short progress messages, visible in the JSP reporting application. If parent builders exist (eg: composite), and any parent's show. Progress=false. then no progress messages will be shown, regardless of this builder's show.
Progress setting. No (defaults to true)If true, the builder will write all output to a file that can be read by the Dashboard reporting. When Cruise. Control runs your build script (e. Ant, Maven), it passes.
These. can be accessed in your script like any other property, using the syntax. Here's a list of all the properties that are available to your. Property Name. Descriptionprojectname. The name of the Cruise. Control project. label. The build label determined by the labelincrementercvstimestamp.
Timestamp that indicates when the build started, using the. MM- dd HH: mm: ss 'GMT' so it. CVS argumentcctimestamp. Timestamp that indicates when the build started, using the. MMdd. HHmmsscclastgoodbuildtimestamp. Timestamp that indicates when the last successful build was.
MMdd. HHmmss. Only available. Timestamp that indicates when the last build was run, using. MMdd. HHmmss. Only available if the. Some child elements of < modificationset>. In particular: < buildstatus> sets specific.
If specified, the property or. This. feature is supported by < clearcase>. Specifies an Ant build to be run at a given time or build number. For instance, we can run a clean build every 5 builds, or run more.
We. can also schedule an official build to run every night at midnight. When a build runs, Ant is invoked in a separate Java process. There. are two alternative ways in which ant may be invoked: Using the antscript, or anthome, attribute (preferred). Cruise. Control distribution, and that. Cruise. Control. Using the ant binaries distributed with Cruise. Control. Settings.
This also requires that java be on. The standard Cruise. Control properties.
See below for examples of the. See also the common. Attribute. Required. Descriptionbuildfile. No (defaults to build.
Path to Ant build file. No. Ant target(s) to run. Default is "", or the default target.
No. Name of temp file. Defaults to log. xmlantscript. No, but recommended. Cannot be specified if anthome attribute is also specified. Absolute filename of script (shell script or bat file) used. Ant. You can use this to make Cruise. Control use your own.
Ant installation. If this is not specified, the Ant.
Builder uses. the Ant distribution that ships with Cruise. Control. See below. No. Cannot be specified if antscript attribute is also specified. Directory in which Ant is installed. Cruise. Control will attempt to use the standard.
Ant execution scripts (i. See below. for examples. Working. Dir. No.
Will invoke ant in the specified directory. Log. Dir. No. If supplied a copy of the ant log will be saved in the specified directory. Example. save. Log. Dir="/usr/local/dev/projects/cc/logs"timeout. No. Ant build will be halted if it continues longer than the. Value in seconds.
No'true' if Cruise. Control should call Ant using - logger. Ant using '- listener', thus using the. Listener. uselogger="true" will make Ant. Ant Logger, which can make for smaller log files since. DEBUG messages (see use.
Debug and use. Quiet. Ant manual). Set to false to have Ant echo ant messages to console using its. Default. Logger, which is useful when debugging your ant build. Defaults to 'false' to make initial setup easier but setting it to. RE: live. Output: If live. Output=true AND uselogger=true, this builder will write the ant output to a.
Builder. Output. log) that can be read by the Dashboard reporting application. The live. Output setting has no effect if uselogger=false. Ant. Bootstrapper and Ant. Publisher. do not provide access to live.
Output, and operate as if live. Output=false. NOTE: In order to show ant output while uselogger=true, the Ant. Builder uses a custom Build Listener. If this interferes with your Ant build, set live.
Output=false (and please report the problem). No (defaults to org. Xml. Logger)If you want to use another logger (or listener, when. Ant's Xml. Logger.
The logger. needs to output compatible XML, and the class needs to be. No. If true will invoke ant with - debug, which can be. Defaults to 'false'. When used in combination with uselogger="true", this will. XML log files; otherwise, it will cause. Ant's. Default. Logger.
No. If true will invoke ant with - quiet, which can be. INFO will not be logged. Defaults to 'false'. Smaller logfiles are only achieved when used in combination. Ant's Default. Logger.
RE: show. Progress: use. Quiet="true" will prevent any progress messages from being displayed. NOTE: In order to show progress, the Ant. Builder uses custom Build Loggers and Listeners. If these interfere with your Ant build, set show. Progress=false (and please report the problem).
No. If true will invoke ant with - keep- going, which can be. Defaults to 'false'. No. Load all properties from file with - D properties. Useful when the propertyfile content can change for every build. Logger. Lib. No. Overrides the default - lib search path used to add support for show. Progress features. This search path ensures customized ant Loggers/Listeners.
VM. You should not normally. If you do set this value, you should use the full path (including filename). This setting has no effect if show. Progress=false. Element. Cardinality. Description< jvmarg> 0 . Pass specified argument to the jvm used to invoke ant. Ignored if using anthome or antscript.
The element has a single required. Example: < jvmarg arg="- Xmx. Used to define properties for the ant build. The element. has two required attributes: "name" and "value". These will. be passed on the ant command- line as "- Dname=value"Example: < property name="foo" value="bar"/> < lib> 0 . Used to define additional library directories for the ant build.
The element. has one required attribute: "search. Path". Example: < lib search. Path="/home/me/myantextensions"/> < listener> 0 . Used to define additional listeners for the ant build. The element. has one required attribute: "classname". Example: < listener classname="org.
Log. 4j. Listener"/> Invoke the ant. D: \workspace\My. Project and the. ant build file as My. Project- nightlybuild. C: \Java\apache- ant- 1.
D: \workspace\My. Project". buildfile="My. Project- nightlybuild. Or equivalently, using the anthome attribute. C: \Java\apache- ant- 1.
D: \workspace\My. Project". buildfile="My. Project- nightlybuild. Invoke a custom ant script /home/cc/workspace/build. The custom build script can be any shell script, batch file or. Here is an example that. Unix: #!/bin/sh. PROJECT_HOME=`dirname "$0"`.
ANT_HOME=${PROJECT_HOME}/tools/ant. ANT_HOME}/bin/ant. ANT_CMD=${ANT_HOME}/bin/ant. ANT_CMD" "$@"Note the double quotes around $@: this ensures that all arguments.
An example of a Windows batch file to invoke ant: @echo off. PROJECT_HOME=%~dp. PROJECT_HOME%.\devtools\env.
The %* as a param to ant. If this is. skipped then Cruise.
Control wouldn't work properly. Specify a Maven build to be. Basically, it behaves like the. Ant. Builder, with some differences noted below. Maven. Builder runs (an.
Maven over the specified project. Due to the. current status of Maven (in heavy development) only the "script" start. The goal attribute has the following usage examples: "clean" will run 'clean' goal on the project"clean java: compile" will run 'clean' goal then 'java: compile'. Maven session run"clean my- cvs- update|java: compile" will run 'clean' goal then.
Maven. session run, then it will run Maven again with goal. Handy behavior for running update goals that update. Arbitrary number of subsets. Subset separator is '|'. The standard Cruise.
Control properties. Attributes. See also the common.
Attribute. Required. Descriptionmavenscript. Yes. Absolute filename of maven startup script (maven. Yes. Path to Maven's "project. Yes. Maven goal, "set of goals" or "set of set of goals" to run.
Note. 2)timeout. No. Build will be halted if it continues longer than the specified timeout. Value in seconds. Specify a Maven. 2 build to be.
Basically, it behaves like the. Ant. Builder, with some differences noted below. Maven. 2Builder runs (an.
Maven. 2 over the specified project. Due to the. current status of Maven (in heavy development) only the "script" start. The goal attribute has the following usage examples: "clean" will run 'clean' goal on the project"clean compile" will run 'clean' goal then 'compile'.
Maven. 2 session run"clean scm: update|deploy" will run 'clean' goal then. Maven. session run, then it will run Maven again with goal.
Handy behavior for running update goals that update. Arbitrary number of subsets. Subset separator is '|'.
The standard Cruise. Control properties. The. "cvstimestamp" property contains spaces in its value, like. Dcvstimestamp=2. 00. GMT. To avoid problems when maven. Dcvstimestamp=2. 00.
GMT. Attributes. See also the common. Attribute. Required. Descriptionmvnscript.
One of these. Path to maven startup script (../bin/mvn. Path to Maven. 2's home directory (M2_HOME). Maven script will be found. Yes. Path to Maven. Yes. Maven. 2 goal, "set of goals" or "set of set of goals" to run. Goals note above)sitegoal. No. Maven. 2 site goal, "set of site goals" or "set of set of site goals" to run after those configured in above mentioned goal attribute.
For example < maven. This way it is possible to supply a site with test failure info. No. Alternate path for the user settings file. No. Comma- delimited list of profiles to activate. No. Command line flags to be passed to maven. For example. '- U - Dmaven.
The flags will be passed to each session. Sessions note above). No. Build will be halted if it continues longer than the specified timeout.
Value in seconds. Element. Cardinality.
Description< property> 0 . Used to define properties for the maven. The element. has two required attributes: "name" and "value". These will. be passed on the maven. Dname=value" to each session. Sessions note above). Example: < property name="foo" value="bar"/> top.
The Composite. Builder executes a list of builders (any builder, except < pause> ). This is necessary. CRISP- builds in Pragmatic Project Automation. Mike Clark) Attributes. See also the common. Attribute. Required. Descriptiontimeout.
No. Composite Build will be halted if it continues longer than the specified timeout. Value in seconds.
Progress. No (defaults to true)If true or omitted, the composite builder will provide progress messages, as will any child builders that support this. Progress setting is true). If false, no progress messages will be shown by the composite builder or child builders - regardless of child builder. Progress settings.
If any parent show. Progress is false, then no progress will be shown, regardless. Output. No (defaults to true)Currently, the live.
Output setting has no effect on composite builders. Child Elements. Element. Cardinality. Description< ant> 0 . Builds the project using Ant.< maven> 0 . Builds the project using Maven.< maven. Builds the project using Maven. Builds the project using NAnt.< phing> 0 .
Builds the project using Phing.< rake> 0 . Builds the project using Rake.< exec> 0 . Builds the project using the Exec. Builder.< pipedexec> 0 . Builds the project using the Piped. Exec. Builder.< xcode> 0 .
Builds the project using Apple's Xcode IDE. It may be necessary for Cruise. Control to halt executing in some. A disk backup could lock the source control repository. Cruise. Control to return errors. Rather than deal with these.
Cruise. Control to. Attributes. Attribute. Required. Descriptionday. No. Day when the pause should take place (Sunday, Monday, etc). Does not support multiple days except for the default of every. Yes. Start of the pause in HHmm formatendtime. Yes. End of the pause in HHmm formattop.
Specifies a NAnt build to be run at a given time or build number. For instance, we can run a clean build every 5 builds, or run more. We. can also schedule an official build to run every night at midnight. When a build runs, NAnt is invoked in a separate Java process. NAnt. and the . NET Framework or Mono need to be installed for this builder. See NAnt's documentation for details on configuration. NET implementations.
The standard Cruise. Control properties. NAnt build. See below for examples of the. Attributes. See also the common. Attribute. Required. Descriptionbuildfile. No (defaults to default.
Path to NAnt build file. No. NAnt target(s) to run. Default is "", or the default target. No. Name of temp file. Defaults to log. xmltarget. Framework. No, but recommended.
Specifies the framework to target. Typical values are. Working. Dir. No.
Will invoke NAnt in the specified directory. No. NAnt build will be halted if it continues longer than the. Value in seconds. No'true' if Cruise. Control should call NAnt using - logger. NAnt without '- logger', thus using the.
Listener. uselogger="true" will make NAnt. NAnt Logger, which can make for smaller log files since. DEBUG messages (see use. Debug and use. Quiet. NAnt documentation).
Listener will echo NAnt messages to console which is. NAnt build. Defaults to 'false'. No (defaults to NAnt. Core. Xml. Logger)If you want to use another logger than NAnt's Xml. Logger. you can specify the classname of the logger here. The logger. needs to output compatible XML, and the class needs to be. No. If true will invoke NAnt with - debug, which can be.
NAnt build. Defaults to 'false'. Is only effective when used in combination with uselogger="true"!usequiet. No. If true will invoke NAnt with - quiet, which can be. INFO will not be logged. Defaults to 'false'. Is only effective when used in combination with uselogger="true"!Child Elements.
Element. Cardinality. Description< property> 0 . Used to define properties for the NAnt build. The element. has two required attributes: "name" and "value". These will. be passed on the NAnt command- line as "- D: name=value"Example: < property name="foo" value="bar"/> Invoke NAnt, specifying the. D: \workspace\My. Project and the. NAnt build file as My.
Project- nightly. D: \workspace\My.
Project". buildfile="My. Project- nightly. Invoke NAnt, specifying the working directory as /home/cc/workspace. NET version 1. 1. Specifies a Phing build to be run at a given time or build number. For instance, we can run a clean build every 5 builds, or run more. We. can also schedule an official build to run every night at midnight.
When a build runs, Phing is invoked in a separate Java process. Phing and the PHP requisites need.
See Phing's documentation for details on installation. The standard Cruise. Control properties. Phing build. See below for examples of the. See also the common.
Attribute. Required. Descriptionbuildfile. No (defaults to build.
Path to Phing build file. No. Phing target(s) to run. Default is "", or the default target. No. Name of temp file. Defaults to log. xmlphingscript. No. Cannot be specified if phinghome attribute is also specified. Absolute filename of script (shell script or bat file) used.
Phing. If this is not specified, the Phing. Builder assumes that phing (or phing. No. Cannot be specified if phingscript attribute is also specified.
Directory in which Phing is installed. Cruise. Control will attempt to use the standard.
Phing execution scripts (i. See below for examples. Working. Dir. No. Will invoke phing in the specified directory. Log. Dir. No. If supplied a copy of the phing log will be saved in the specified directory.
Example. save. Log. Dir="/usr/local/dev/projects/cc/logs"timeout. No. Phing build will be halted if it continues longer than the. Value in seconds.
No'true' if Cruise. Control should call Phing using - logger; 'false' to call Phing using '- listener'. Listener. uselogger="true" will make Phing log its messages using the. Phing Logger, which can make for smaller log files since it. DEBUG messages (see use. Debug and use. Quiet attributes below, and the Phing manual). Set to false. to have Phing echo messages to console using its Default.
Logger, which is useful when debugging your Phing. Defaults to 'false' to make initial setup easier but setting it to 'true' is recommended for. No (defaults to phing. Xml. Logger)If you want to use another logger (or listener, when uselogger="false") than Phing's Xml. Logger. you can specify the classname of the logger here.
The logger needs to output compatible XML, and. No. If true will invoke phing with - debug, which can be.
Defaults to 'false'. When used in combination with uselogger="true", this will.
XML log files; otherwise, it will cause. Phing's. Default. Logger. usequiet. No. If true will invoke phing with - quiet, which can be.
INFO will not be logged. Defaults to 'false'. Smaller logfiles are only achieved when used in combination. Phing's Default. Logger.
Element. Cardinality. Description< property> 0 . Used to define properties for the phing build. The element. has two required attributes: "name" and "value". These will. be passed on the phing command- line as "- Dname=value"Example: < property name="foo" value="bar"/> Invoke the phing. D: \workspace\My.
Project and the. phing build file as My. Project- nightlybuild.
C: \PHP\applications\phing- 2. D: \workspace\My. Project". buildfile="My.
Project- nightlybuild. Or equivalently, using the phinghome attribute. C: \PHP\applications\phing- 2. D: \workspace\My. Project". buildfile="My. Project- nightlybuild. Specifies a Ruby Rake build to be run at a given time or build number.
For instance, we can run a clean build every 5 builds, or run more. We. can also schedule an official build to run every night at midnight. When a build runs, Rake is invoked in a separate Java process. See also the common. Attribute. Required. Descriptionruby. No (defaults to ruby)Name of / Path to the ruby interpreter. Typical values are "ruby", "ruby.
No (defaults to rake)Name of / Path to the rake binary. Typical values are "rake", "rake. No (defaults to Rakefile)Path to Rake build file. If the rakefile is not found in the current directory. The directory where the.
Rakefile is found will become the current directory for the actions executed. Rakefiletarget. No. Rake target(s) to run. Default is "", or the default target. Dir. No. Will invoke rake in the specified directory. The directory can.
No. Rake build will be halted if it continues longer than the. Value in seconds. Runs a specified command or script as part of the build. Reports build. failure if the command cannot be run or returns an error. There is also. a capability to search for a user defined string in the command output, for example. Arguments will have any. See below for examples of the.
Attributes. See also the common. Attribute. Required. Descriptioncommand.
Yes. The command or script to be executed. No. Set of arguments (as a single string) to be passed to the command or script. No. The directory in which the script or command is to be. Defaults to the Java temporary directory. No. String which is to be searched for in the output of the.
If it is found then the build will return. No. Build will be halted if the script or command continues longer. Value in seconds. Invoke execbuilder, specifying the. Perl script backup.
Perl". args="backup. Invoke execbuilder, specifying the working directory as D: \Workspace\My. Project. the script file as build. D: \Workspace\My. Project". args="smoketest".
Invoke execbuilder to call a function of the shell, in this case copy. D: \Workspace\My.
Project". args="copy foo. Piped exec builder executes a list of < exec> builders (commands. STDIN of any number of the builders may be fed by STDOUT of a.
All the child builders are started in. STDIN are blocked by the OS until their STDINs are filled. The Piped. Exec. Builder captures the STDOUTs of the running child builders, caches. To prevent memory exhaustion when several large- memory- consuming builders are running at. Still, they may be piped from.
The whole piped exec builder finishes when all its child builders are finished. When any of. children fails, the piped exec builder terminates all the running commands or scripts, and. Let us note here the scripts used in. STDERR for. state/error reporting. The child < exec> builders have the same capabilities as the original < exec>. See below for examples of the. Attributes. See also the common.
Attribute. Required. Descriptionworkingdir. No. The directory in which all the scripts or commands are to be. Each individual script or command may override this value. Defaults to the Java temporary directory.
No. Build will be halted if the scripts or commands running under the pipedexec. Each individual script or command. Value in seconds. Child Elements. Element. Cardinality. Description< exec> 0 . Runs a specified command or script under the piped exec builder, and optionally. The < exec> element is based on the Exec.
Builder, so it. has the same attributes and capabilities (i. In addition, < exec> as piped exec. Attribute. Required. Descriptionid. Yes. The unique identifier of the command or script script (any.
The value is referenced by pipefrom. No. The ID of script to connect to - the STDIO of this command or. STDOUT of < exec> with the given ID. Several < exec> may be piped from one ID.
No. The execution of this command or script will be hold until. ID finishes. It may be used. STDOUT- STDIN. pipe. Suppose that all the scripts read data either from input file (option - i), or from. STDIN if no file is given. Also suppose that they write output into file (option - o). STDOUT if no file is given.
Invoke piped exec builder, specifying the. Perl scripts first. Perl". args="first.
Perl". args="second. Invoke piped exec builder, specifying another working directory for the last script. An error in the first script is. The sequence. is now first. Perl". args="first. Perl". args="second.
Perl". args="third. Invoke more complicated piped exec builder, where 5th script required data generated by.
Therefore. scripts must wait for each other. Perl". args="first. Perl". args="second.
Perl". args="third. Perl". args="fourth.
Without 'waitfor' it would be started. Perl". args="fiveth. The same here - ->.
Perl". args="sixth. Perl". args="seventh. Builds projects for Apple's Xcode IDE using the xcodebuild command- line tool. See also the common.
Attribute. Required. Descriptiondirectory. Yes. Path the directory where xcodebuild will executetimeout. No. Build will be halted if the command continues. Value in. seconds. Element. Cardinality.
Description< arg> 0 . Pass specified argument to xcodebuild. The element. has the required attribute: value.
Any of the properties passed to. Example: < arg value="- project. Optional element specifies where cruisecontrol log files are stored. Cruise. Control build log. Attributes. Attribute. Required. Descriptiondir. No. The cruisecontrol log directory.
Default is "logs/[projectname]". No. Encoding for Cruise. Control's XML log file. Whitespace. Noif true, trim whitespace from start and end of log lines. Primarily intended only to force historic "trim" behavior. Defaults to false.
Child Elements. Element. Cardinality. Description< merge> 0 . Merges log file together.< gzip> 0 .
GZips old log files< delete> 0 . Deletes old log files.< deleteartifacts> 0 . Deletes old artifact directories. After the build is complete, there may be other xml artifacts to. The most common of these is the. Ant < junit> task creates.
We can add. a merge entry for these files so that we have one comprehensive log at. Attributes. Attribute.
Required. Descriptionfile. One of file or dir. No (defaults to true)when merging a JUnit xml file should the properties section be removed. No. Specifies the pattern which matches the filenames to merge. This pattern should be a valid Jakarta- ORO Glob pattern.
Defaults to "*. xml". After the build- file is written, this manipulator gzips all old log files. Attributes. Attribute. Required. Descriptioneverytrue. Sets the amount of Units after which the logfiles are backuped. The Unit for backups.
Valid Units are DAY, WEEK, MONTH or YEARtop. After the build- file is written, this manipulator deletes all old log files. Attributes. Attribute. Required. Descriptioneverytrue. Sets the amount of Units after which the logfiles are deleted. The Unit for deletions. Valid Units are DAY, WEEK, MONTH or YEARignore.
Suffixtrue. Ignores default xml- suffix when deleting files, so other logfiles could be deletedtop. After the build- file is written, this manipulator deletes all old artifact directories. Attributes. Attribute. Required. Descriptioneverytrue. Sets the amount of Units after which the artifact directories are deleted. The Unit for deletions. Valid Units are DAY, WEEK, MONTH or YEARtop.
Publishers are run after a build has completed. They will be run. Child Elements. Element. Cardinality. Description< antpublisher> 0 .
Executes an Ant script which implements a custom publisher.< artifactspublisher> 0 . Copies build products to a directory< clearcasebaselinepublisher> 0 .
Creates a Clear. Case UCM baseline.< cmsynergybaselinepublisher> 0 . Creates an intermediate baseline in a CM Synergy database.< cmsynergytaskpublisher> 0 . Copies all new CM Synergy tasks into a shared folder.< compoundpublisher> 0 .
Executes all publishers specified as child elements.< email> 0 . Sends an email with a URL to the build results JSP< execute> 0 . Execute a command as part of the publishing phase< ftppublisher> 0 . Copies the log file and build artifacts to an FTP server< htmlemail> 0 .
Sends an email with the build results embedded as HTML< http> 0 . Connects to an HTTP URL and sends the build results as parameters< jabber> 0 . Sends an instant message with a link to the build results. Jabber server using XMPP< onfailure> 0 . Executes all publishers specified as child elements if and only.
Executes all publishers specified as child elements if and only. Creates/closes an issue in an Origo project.< sametimeannouncement> 0 . Sends Sametime announcements with the result of the build< scp> 0 . Copies a file using SCP< sfeedocman> 0 .
Uploads a document to a Source. Forge Enterprise Edition project's Document Manager.< sfeefrs> 0 . Uploads a file to a Source. Forge Enterprise Edition project's file release system (FRS).< sfeetracker> 0 . Creates a Tracker artifact in a Source.
Forge Enterprise Edition project.< socket> 0 . Writes "Success" or "Failure" to a socket< x.
Controls an x. 10 electronic device< xsltlogpublisher> 0 . Performs a transformation of the log file< yahoopublisher> 0 . Sends an instant message with a link to the build results. Yahoo IM messagetop.
Executes an Ant script which implements a custom publisher. Attributes. The antpublisher uses the same attributes. Child Elements. The antpublisher supports the same set of. Properties Passed to the Publisher. The < antpublisher> passes all of. Those properties are augmented by < antpublisher>.
Property Name. Descriptionthisbuildsuccessful. Set to true if the current build was successful, false.
See also the < onsuccess>. The name of the Cruise.
Control project. lastbuild. The timestamp of the last attempted build, using the format.
MMdd. HHmmss. lastsuccessfulbuild. The timestamp of the last successful build, using the format. MMdd. HHmmss. builddate. The date of the last build, formatted using the default format.
The time interval between builds. The directory containing the log file from the last build.
The name of the log file from the last build. Examples. Invoke the ant. D: \workspace\My. Project and the. ant build file as My. Project- nightlybuild.
Pass in the property "custom". C: \Java\apache- ant- 1. D: \workspace\My. Project". buildfile="My.
Project- nightlybuild. You could then do something like the following in. My. Project- nightlybuild.
My. Project- nightlybuild" default="publish">. For additional examples, please.
Copies build products to unique destination directory based on the. Attributes. Attribute. Required. Descriptionfileone of file or dirwill copy specified filedirwill copy all files from this directorydest. Yesparent directory of actual destination directory; actual destination directory name will be the build timestamp. Nosubdirectory under the unique (timestamp) directory to contain artifactspublish. On. Failure. No (defaults to true)Deprecated.
Use < onsuccess> and. Instead. Of. Copy. No (defaults to false)The publisher will move files/directrories instead of copying them. Creates a Clear. Case UCM baseline for the specified view's integration stream. Uses the value of the Cruise. Control generated ${label} property. A baseline is only created if UCM modifications are recorded.
By default an incremental baseline is created although a full. Continuous Integration). Attributes. Attribute. Required. Descriptionviewtag.
Yes. The view tag of the UCM view that you wish to create the baseline in. The baseline is created in the stream that the view is attached to. No. Boolean value indicating whether a "Fully Labelled" or "Incremental".
Default is false, i. Incremental". baselineprefix.
No. A prefix which should be applied together with the Cruise. Control. ${label} property, for example specifying "EXAMPLE_". Cruise. Control generated label of "1_INT" would create a. EXAMPLE_1_INT". component. No. The component to restrict the baseline creation to. By default the baseline. Examples. Create a baseline with the name "J2.
EE_" followed by the Cruise. Control generated. J2. EE_SRC" component. J2. EE_". component = "J2. EE_SRC"/>. < /publishers>. Creates an intermediate baseline which encompass the specified project and.
This publisher will only run if the build was. CM Synergy. task. This publisher will only work with CM Synergy version 6. The build and state attributes are only. Synergy 6. 4+ is detected. Attributes. Attribute.
Required. Descriptionccmexe. No. The name of the CM Synergy command line client. If not provided, the. Windows). sessionfile.
No. The session file used by the. CM Synergy session information. If this attribute is.
No. The session name of the CM Synergy session you wish to use. This name. must appear in the session file. If not set, the plugin will attempt.
Yes. The project spec (two part name) of the project you wish to form the top. Note that all subprojects will also be.
No. The purpose of the baseline. If not specified, this will default to. Integration Testing".
No. An optional description of the baseline. No. An optional name for the baseline. If not provided, CM Synergy will assign. You may incorporate the value. Cruise. Control (in the "info" section of the log). No. A value for the build attribute introduced for baselines since Synergy.
No. A value specifying the state the the baseline should be created with. The state attribute is new since Synergy 6.
Acceptable values for the attribute are "published_baseline. The default value is "published_baseline".
Examples. Create a baseline with the name "BUILD_" followed by the CC timestamp for the. Integration Testing" using the session called "j. BUILD_@{cctimestamp}"/>.
The < cmsynergytaskpublisher> is used to copy tasks into a shared. The folder may be specified by number. This publisher will only run if the build was. CM Synergy task. Attributes. Attribute. Required. Descriptionccmexe.
No. The name of the CM Synergy command line client. If not provided, the. Windows). sessionfile. No. The session file used by the. CM Synergy session information. If this attribute is.
No. The session name of the CM Synergy session you wish to use. This name. must appear in the session file. If not set, the plugin will attempt.
Either foldernumber or foldername and project. The number of the target folder. A substring of the name of the target folder (i. Integration. tested tasks"). If this attribute is set, you must also set the. The two part name of the project which contains the named folder.
Examples. Publish all new tasks into folder number 2. CM Synergy session. Publish all new tasks into the folder called "Integration tested tasks. CM. Synergy session named "j. Integration tested tasks"/>. SCP a file as part of the publishing process.
Attributes. Attribute. Required. Descriptionexecutable. Name. No. Specify the name of the executable to invoke. Default is "scp". Yes if sourcehost is specified. Log in to the sourcemachine as this user. Yes if sourceuser is specified.
SCP from this machine. No (defaults to '.')The directory to copy from. Yes if targethost is specified. Log in to the target machine as this user. Yes if targetuser is specified. SCP to this machine. No (defaults to '.')The directory to copy to.
No (defaults to File. The file separator on the target machine. No (defaults to File. The file separator on the source machine. Useful when using an alternate shell. Cygwin, that expects a separator that differs from the native OS.
No (defaults to 'ssh')The ssh application. No. Additional options to pass to SCP. No (defaults to the current logfile)The filename to copy. Creates a Document Manager document in a Source. Forge Enterprise Edition project. All. child elements may include either hardcoded values, or use an xpath expression to define the value at runtime.
NOTE: To use this publisher, you must supply the jars included in the Source. Forge SOAP SDK. The publisher is compiled against a stub implementation of that SDK. Remove the stub jar.
SDK jars in its place and make them available in. Cruise. Control's classpath. Attributes. Attribute. Required. Descriptionserverurl. Yes. URL for the SFEE instance. Yes. Valid username for the specified SFEE instance. Yes. Password for the specified username.
Yes. The path to the document to publish. Yes. The Document Manager folder in which to publish. Name. Yes. The name of the SFEE project where the Document Manager folder specified exists. Child Elements. Element.
Cardinality. Description< description> 1. The description for the Document.
This child element is required and is an. XPath Aware Child. Look there for attribute details.
The status for the Document. This child element is required and is an. XPath Aware Child. Look there for attribute details. The name for the Document within the Document Manager.
If a Document Manager entry already exists. If this child is not included, it will default to the name of the file being published. This child element is optional and is a.
XPath Aware Child. Look there for attribute details. The version comment for the Document. This child element is optional and is a. XPath Aware Child.
Look there for attribute details. Examples. < !- - Upload Project.
SFEE, using XPath to set. Root Folder/". document="projects/myproject/Project. Uploads a file to a Source. Forge Enterprise Edition project's file release system (FRS). NOTE: To use this publisher, you must supply the jars included in the Source. Forge SOAP SDK. The publisher is compiled against a stub implementation of that SDK. Remove the stub jar.
SDK jars in its place and make them available in. Cruise. Control's classpath.
Attributes. Attribute. Required. Descriptionfile. Yes. Path to a file on the local filesystem that should be uploaded. Yes. URL for the SFEE instance. Yes. Valid username for the specified SFEE instance. Yes. Password for the specified username. Yes. The SFEE id for the FRS release, e.
No (defaults to the same name as the local file)The name to be used for the file in the FRS. Examples. < !- - Upload myapp- 1.
SFEE using the same filename. Upload myapp- 1. 0. SFEE, but call it myapp- current. FRS. - ->. < sfeefrs file="target/myapp- 1. Creates a Tracker artifact in a Source.
Forge Enterprise Edition project. Artifact fields are defined. Other. fields with arbitrary names and values are defined as "field" subelements. All fields may include either. NOTE: To use this publisher, you must supply the jars included in the Source. Forge SOAP SDK. The publisher is compiled against a stub implementation of that SDK. Remove the stub jar.
SDK jars in its place and make them available in. Cruise. Control's classpath. Attributes. Attribute. Required. Descriptiontracker. Name. Yes. The name of the Tracker within the specified SFEE project.
Name. Yes. The name of the SFEE project where the tracker specified exists. Yes. URL for the SFEE instance.
Yes. Valid username for the specified SFEE instance. Yes. Password for the specified username. Child Elements. Element. Cardinality. Description< title> 1. The title for the tracker artifact. This child element is required and is an. XPath Aware Child.
Look there for attribute details. The description for the tracker artifact.
This child element is required and is an. XPath Aware Child. Look there for attribute details. The status for the tracker artifact. This child element is required and is an. XPath Aware Child.
Look there for attribute details. Sets a field that exists in the tracker artifact. This child element is optional and is a. Named XPath Aware Child. Look there for attribute details. Examples. < !- - Creates a new SFEE tracker entry for monitoring unit test statistics.
Name="Unit. Test. Statistics". project. Name="mysfeeproject">.
Unit Tests" />. The test statistics from my SFEE project." />.
Closed" />. < field name="Total. Number. Of. Unit. Tests" xpath. Expression="sum(cruisecontrol/testsuite/@tests)" />.
Sends an email with a URL to the build results JSP. Attributes. Attribute. Required. Descriptionbuildresultsurl. No. URL to the build results JSP. This defaults to the hostname, domain name and web port (if specified) of the server, followed by /dashboard. No. Default e- mail suffix to append to user names to build. This defaults to an empty string if.
No. Flag emails about failed builds as important? Default is 'true'. No. Mail server address to use for sending build notification emails. If not set, Cruise. Control will attempt to connect directly to the SMTP servers defined in the DNS MX records for each recipient's domain. No. Mail server portusernameif password is specified.
Username for smtp serverpasswordif username is specified. Password for smtp serverreportsuccess. No (defaults to always. Valid values. always: publishes (i. Yes. E- mail address that will appear in the sent email's From fieldreturnname. No. A name to match to the return addressskipusers.
No (defaults to false)Controls if the users who made changes in this build get. Useful to set to "true" while configuring or debugging.
Users specified by the failure or always nested. No (defaults to true)Whether or not e- mail reports on failed builds will continue. No. Prefix for subject line of email.
Useful for easily. No"true" to connect to the smtp server using SSL.
Do not forget to set the corresponding mailport. Child Elements. Element.
Cardinality. Description. Mail address to be emailed notification after all builds. Attribute. Required. Descriptionaddress.
Yese- mail address. Mail address to be emailed notification after failed builds. Attribute. Required. Descriptionaddress. Yese- mail addressreport.
When. Fixed. Noeither true or false; defaults to false. User name to be removed from the user list, thus not sent any email. Useful for removing the fake user names created by some sourcecontrols. Attribute. Required.
Descriptionuser. Yesuser name from modification to be ignored. Mail address to be emailed notification after successful builds. Attribute. Required. Descriptionaddress. Yese- mail address.
Mail address to be emailed notification if any of the build's. Attribute. Required. Descriptionfile. Reg. Expr. Yes. A regular expression indicating which modified. Yese- mail address. Maps a source control user id to an email address. Attribute. Required.
Descriptionalias. Yesalias (username) as it appears on modificationsaddress. Yese- mail address. Attribute. Required.
Descriptionfile. Yes. Full path to a java properties file where each. Map source control user names to their respective email address using.
Harvest user id and email address stored in the Harvest repository. Attribute. Required.
Descriptionbroker. Yes. The name of the Harvest Broker to connect to. Yes. Usename to use in connecting to the Harvest Broker. Yes. Password to use in connecting to the Harvest Broker. Map source control user names to their respective email address as. Maven's POM (suitable for Maven 1 and 2).
Used for the mapping. Attribute. Required. Descriptionprojectfile. Yes. Full path to Maven's project. Maven 1) or pom. xml (Maven 2) file. Attribute. Required.
Descriptionurl. Yes. URL used to connect to an LDAP server, e. Yessearch DN, scope is sub- tree- levelbinddnno. DN to bind to the LDAPbindpasswordif binddn is specifiedpassword to bind to the LDAPsearchtmpl. No. Search filter.
Default: (cn=?). The ? No. Default: mail. The LDAP attribute that is searched. No. Default: com. Ldap. Ctx. Factory.
LDAP Context Factory to be used. Sends an email with the build results embedded as HTML.
By default. the same information as the JSP build results page is sent. Typical usage is to define xsldir and css to point to cruisecontrol locations.
This. publisher creates HTML email by transforming information based on a set of internally. Currently "header. This list can be changed, or appended to, using xslfilelist attribute.
Alternatively, you. Attributes. All of the attributes and child elements of < email>. The following table. Attribute. Required. Descriptionbuildresultsurl.
No. Email will include link to the build results JSP if this. URL is provided. charset. No. If not set the content type will be set to 'text/html'.
If. set the content type will be 'text/html; charset="value"'. Path to cruisecontrol. Used only if xsldir set and. Starting with version 2.
HTMLEmail. Publisher. No (Yes for versions < 2. Path to the log directory as set in the log element of.
Follows default of log's dir- attribute since version 2. Directory where standard Cruise. Control xsl files are. Starting with version 2. HTMLEmail. Publisher.
No. If specified, xsldir, xslfilelist, and css are ignored. Must. handle the entire document.
No. Works with xsldir and css. String, representing ordered list of xsl files. HTML email. List is comma. If first character of list is plus sign ("+"), the listed. HTMLEmail. Publisher. If. xslfilelist is not specified, email is published using hard- coded list of.
Child Elements. Element. Cardinality. Description. Parameters passed to the XSL files before transforming them to HTML. Check. the Reporting application's. XSL files. < parameter/> has the following attributes. Attribute. Required. Descriptionname. Yesthe name of the XSLT parametervalue.
Yesthe parameter's valuetop. Connects to an HTTP URL and sends the build results as parameters. Build results can be sent to a URL using any of the HTTP methods. Attributes. Attribute. Required. Descriptionurl. Yes. The URL to connect to. Must be of the HTTP protocol.
Method. Yes. HTTP request method. POST, GET etc. Child Elements. Element. Cardinality. Description< parameter> 0.*Sets an HTTP attribute- value parameter. If the request method is GET, the attribute- value pairs are. URL string. Otherwise they are included in the message body. This child element is optional and is a.
Named XPath Aware Child. Look there for attribute details. Sends an instant message with a link to the build results via a Jabber server. XMPP. Attributes. Attribute. Required. Descriptionhost. Yes.
The host of the Jabber server. No. Port of the Jabber server.
Defaults to 5. 22. Note: SSL typically. Yes. Username of the account used to send the instant message.
For individuals. this is typically of the form 'foo' as opposed to 'foo@bar. Yes. Password of the sender accountrecipient. Yes. Username of the recipient of the instant message. Recipient username.
No. Whether the recipient is a group/chat (true) versus an individual (false). Defaults to false. No. Whether the XMPP connection on host: port is using SSL. Yes. Email will include link to the build results. No. Service to use. Provides the means to execute another publisher.
This is accomplished by simply adding any desired publishers as child. All child elements must meet the following criteria. They must be registered as publishers.
If you are adding a publisher. Cruise. Control, this will be done for you automatically. If you are adding a custom publisher, you must remember to register it with.
Cruise. Control using a. They must validate successfully regardless of whether or not.
Child Elements. Element. Cardinality. Description. Any defined publisher. You may use any defined publisher as a child element. Examples. After a failed build, use the x. Ant script to do some cleanup. Code="A" device. Code="3"/>.
Provides the means to execute another publisher. This is accomplished by simply adding any desired publishers as child. All child elements must meet the following criteria. They must be registered as publishers. If you are adding a publisher. Cruise. Control, this will be done for you automatically.
If you are adding a custom publisher, you must remember to register it with. Cruise. Control using a. They must validate successfully regardless of whether or not.
Child Elements. Element. Cardinality. Description. Any defined publisher. You may use any defined publisher as a child element. Examples. After a successful build, use the x. Code="A" device. Code="7"/>.
Creates a new issue in an Origo system if a build fails and closes. Attributes. Attribute. Required. Descriptionapiurl. No (defaults to http: //api. URL to Origo APIbuildresultsurl. No (defaults to http: //localhost: 8. URL to the build results JSPissueprivate.
No (defaults to true)Should the issue be privateissuesubject. No (defaults to Cruisecontrol failed)Subject for newly created issueissuetag. No (defaults to cruisecontrol: :failed)Tag for newly created issue, must be unique in the projectprojectname. Yes. Name of the origo projectuserkey. Yes. Origo user key to report/update the issue. Examples. Create/update an issue in the ethz Origo instance for the project Connectfour. SOMEVERYSECRETKEY".
Publishes an Really Simple Syndication (RSS) feed of build results. Multiple Cruise. Control projects can publish into the same RSS feed.
Attributes. Attribute. Required. Descriptionbuildresultsurlyes. RSS item will include a link to the build results page. Build results URL should look like 'http: //MACHINENAME/cruisecontrol/buildresults/PROJECTNAME'. No. The primary URL associated with the RSS feed. Yes. The location to which the RSS file should be published.
If an RSS file already exists in this location. RSS attributes (title, description, channel link URL, news items) will be preserved. No. The maximum number of items to maintain in the RSS file. Defaults to 1. 0. A publisher that sends Sametime announcements (optionally with a URL. JSP) with the overall result of the build. Almost. all of the attributes of < email>.
To use this plugin you'll need to build it. The jar you'll need to build the plugin is STComm. To build the plugin read the directions for Building. Plugins That Need External Libraries.
Attributes. Attribute. Required. Descriptionbuildresultsurl.
No. URL to include with the build results. Yes. Synonym for mail. Host. username. Yes.
User name to login to the Sametime community. No. Password used to login to the Sametime community. If not. specified, an anonymous login (using username) will be. No. Sametime community to login to. Default is null —. No (defaults to true)Whether addresses should be resolved as users.
No (defaults to true)Whether addresses should be resolved as groups. No (defaults to true)Whether to send announcements to the content (members) of a.
No (defaults to recipient)How to handle address resolution conflicts. Valid values. error: abort the announcementwarn: log a warning, ignoring the conflicting addressesignore: ignore the conflicting addressesrecipient: treat all conflicting addresses as recipients of the. No (defaults to error)How to handle address resolution failures.
Valid values. error: abort the announcementwarn: log a warning and proceedignore: ignore the failurehandlequerygroupcontentfails. No (defaults to error)How to handle group content query failures. Valid values. error: abort the announcementwarn: log a warning and proceedignore: ignore the failuretop. Simply writes "Success" or "Failure", followed by the project name, to a socket. Note that you will need to write a socket listener that does something.
Attributes. Attribute. Required. Descriptionsocket.
Server. Yes. Hostname (i. Java socket)port. Yes. Port number for the listening socketsend. Project. Name. No (defaults to true)Whether the project name should be appended to the result string. Fixed. No (defaults to false)Whether the publisher should send "Fixed" instead of "Success" after "Failure".
Will send a tweet with a message of the format "projectname buildmessage", where the build message is one of successful, failed or fixed. Attributes. Attribute. Required. Descriptionusername. Yes. Username for the Twitter account. Yes. Password for the Twitter account. Posts the build results to a weblog using the.
Blogger API. the Meta. Weblog API. or the Live.
Journal API. Examples< !- - Post the build results to your project blog. Blogger API. < weblog api="blogger". CC]". buildresultsurl="http: //buildserver/cruisecontrol/myproject". Post the build results to your project blog.
Meta. Weblog API. CC]". buildresultsurl="http: //buildserver/cruisecontrol/myproject".
Post the build results to your project blog. Live. Journal API. CC]". buildresultsurl="http: //buildserver/cruisecontrol/myproject". Attributes. Attribute. Required. Descriptionapi. No. The API to use for posting to the blog.
Accepted. values include blogger and meta. Weblog. Defaults to. Weblog. blogurl. Yes. The URL where your blog receives XML- RPC requests. Yes. The "identifier" for your blog.
See your blog's. documentation for the correct value. Yes. The username for authentication. Yes. The password for authentication. Yes. The Cruise. Control log directory.
Yes, unless xsldir is used. The XSL stylesheet used for transforming. Yes, unless xslfile is used. The directory containing the XSL stylesheets. You can use the Cruise.
Control distribution's. XSL directory, "${CC_HOME}/reporting/jsp/xsl", or use your.
Yes, if xsldir is used. The path to cruisecontrol. HTML. You can use the Cruise.
Control. distribution's 'cruisecontrol. CC_HOME}/reporting/jsp/css" or use a custom stylesheet.
No. The base URL for the Cruise. Control reporting. Usually of the form. If this. URL is provided, the resulting blog entry will include a link. No. The category to which the blog entries.
For the Blogger API, only one category name. For the Meta. Weblog API, a comma- separated list of. No. The rule for reporting successful builds. Accepted values are "always", "never", and "fixes" (only post. No. The prefix to use for blog entries' title. This Publisher implementation sends a on/off signal to a X1. X1. 0 computer interface, model CM1.
A or CM1. 7A. This allows. For example. use a flashing red light to indicate a broken build. Quick Start. Buy the home automation kit found at http: //www. Plug the computer interface to your serial port (for. COM1 or /dev/tty.
S0), and your powerline. Set the lamp module's house and device code such as A3. Plug in an electronic device to the lamp module like a. Install the Java Communications API on your.
Cruise. Control machine. On Windows, copy win. Cruise. Control lib directory to. JAVA_HOME/bin directory.
On Linux, first. obtain the Linux zip file from. At the time of this writing, the name of the file.
Extract. commapi/jar/comm. Cruise. Control lib directory, overwriting the. Then. extract commapi/lib/lib. Linux. Serial. Parallel.
LD_LIBRARY_PATH to it, like so. LD_LIBRARY_PATH=$HOME/commapi/lib${LD_LIBRARY_PATH+: $LD_LIBRARY_PATH}Add the x. Cruise. Control's config. For example, on Windows. Code="A" device. Code="3" port="COM1" />. On Linux. < x. Code="A" device. Code="1" interface.
Model="cm. 17a" port="/dev/tty. S0" /> For more information about the CM1. A controller, see http: //www. The controller connects to the computer via a serial port, e. COM1. and allows the computer to send (and receive) X1. For more information on X1. This module uses a pure Java implementation of the CM1.
A and CM1. 7A. communication protocol as implemented by Jesse Peterson. To read. more about his library, see http: //www. Readme. html. The jpeterson library requires that the Java Communications API be. For more information on the COMM API, see http: //java.
For convenience, the Java COMM API is included with the Cruise. Control. distribution. On windows, copy the win. Cruise. Control's.
JAVA_HOME/bin directory. NOTE: If you receive the following error: Error loading win.
Unsatisfied. Link. Error: no. win. 32com in java. Windows DLL named win. Cruise. Control's lib directory into your JDK (or JRE) bin. If you don't know what interface your device uses, try the. If the publisher hangs, try a different value for.
Model parameter. The standard behavior for this publisher is to send the device the. If you want the opposite, i.
When. Broken attribute to false. Attributes. Attribute. Required. Descriptionhouse. Code. Yes. The house code for the device to control, A through P case insensitivedevice.
Code. Yes. The device code for the device to control, 1 - > 1. No (defaults to COM2)Serial port to which the computer interface controller is connected, e. COM1on. When. Broken. No (defaults to true)Set to false if the device should turn on when the build is successful and off when failedinterface. Model. No (defaults to CM1. A)Model number for the computer interface controller being used, either CM1. A or CM1. 7A (case.
Examples< !- -Turn on X1. A3 using a CM1. 1A computer interface on COM2. Code="A" device. Code="3"/> < !- -Turn on X1. P1. 2 using a CM1. A computer interface on COM2. Code="P" device. Code="1.
Turn on X1. 0 device(s) A3 using a CM1. A computer interface on COM1. Code="A" device. Code="3" port="COM1"/> < !- -Turn on X1.
A3 using a CM1. 1A computer interface on COM1. Code="A" device. Code="3" port="COM1" on. When. Broken="false"/> < !- -Same as the previous, only explicitly indicating which X1. Code="A" device. Code="3" port="COM1". When. Broken="false" interface. Model="CM1. 1A"/> < !- -Turn on X1.
A3 using a CM1. 7A computer interface on COM1. Code="A" device. Code="3" port="COM1". When. Broken="false" interface. Model="CM1. 7A"/> top. Performs an transformation of the log file. The obvious use is to. HTML files to a website, but could be used to generate other.
Attributes. Attribute. Required. Descriptiondirectory. Yes. Directory for output fileoutfilename. No. Name for the output file. Default uses the build label, 'label. No (defaults to true)Deprecated.
Use < onsuccess> and. Generate file if the build failed?xsltfile. Yes. XSL file to used for the transform. Sends an instant message with a link to the build results via a Yahoo IM message.
To use this plugin. You'll need files ymsg_network_v. To build the plugin.
Building Plugins That Need. External Libraries. Attributes. Attribute. Required. Descriptionusername.
Yes. Username of the account used to send the instant message. For individuals. this is typically of the form 'foo' as opposed to 'foo@yahoo. Yes. Password of the sender accountrecipient.
Yes. Username of the recipient of the instant message. Recipient username. Yes. Email will include link to the build results. Host. No. HTTP proxy to use. Port. No. HTTP proxy port to use.
A < plugin> element registers a classname with an. Plugins can also be pre- configured. This can greatly reduce the configuration file size. The plugins page contains a discussion of. Cruise. Control. Attributes. Attribute. Required. Descriptionname. Yes.
The alias used to refer to the plugin elsewhere in the. Yes. The class that implements the plugin. Label. Incrementers handle incrementing the label used to tag each build. Only one Label. Incrementer can be used at a time per project. The default label incrementer (< labelincrementer> ). Attributes. Attribute. Required. Descriptiondefault.
Label. No (default to "build. Build. Incrementer. No (defaults to false)if true the build number will be incremented. No (defaults to period '.')specifies the separator to use between label and build. Provides default label of.
Has all the same attributes as. A label incrementer for creating consistent, formatted upper. This plugin expects the label format to be either "x_y_z" or "y_z".
String, y is an integer and z is one of REL, INT or BLD, i. MYPROJ_1_INT or 1_REL. Attributes. Attribute.
Required. Descriptiondefault. Label. No. Set label to use if there is no saved label. Default is CC_1_INT. Build. Incrementer. No. If true the build number will be incremented. Default is false. No. Indications if a prefix is required (three part label) or not (two part label).
Default is true. separator. No. Specifies the separator to use between portions of the label. Default is underscore '_'top. Creates a label from either a given Perforce changelist number. A changelist number can. Perforce, because a. This class also has features.
This incrementer. Even though the Perforce Bootstrapper. Putting the synchronization after. This feature can be turned off. Sync to true. By default, the class will use to the most currently submitted. If you wish to use a specific changelist.
Whichever. of these is chosen, the synchronize step (if enabled) will sync. A good habit of build environments entails ensuring that the local. To support that. this class can delete the directories under Perforce view by.
This will force the local clients to be removed first (ala. Removing the local client files (sync #0) can be done without. Attributes. Attribute. Required. Descriptionchangelist. Noset the changelist number to sync to.
Not specifying this. Yes. Perforce Server connection to use (host: port)client. Yes. Perforce Client name to useuser. Yes. Perforce User name to usepasswd. No. Perforce password to useview.
Yes. Valid Perforce view (i. No (defaults to period '.')specifies the separator to use between label and build. Sync. No (defaults to false)enable to turn off synchronizing the depot to the. No (defaults to false)syncs the view to revision 0, which removes the current. Enabling this will. Sync to be false. No (defaults to false)deletes any remaining files from the view that the clean.
Enabling this will also force the clean to occur. Sync to be false. Returns a value for the label from a property file. Note: If you use the Ant < buildnumber> task to increment your build number.
Cruisecontrol < propertyfilelabelincrementer> , you may find the build number. Ant and the label seen in Cruisecontrol are different after certain builds fail. This. can happen if the Ant build fails after the < buildnumber> task has run. The build number is incremented. Ant, but Cruisecontrol retains the build number of the last failed build and re- uses it until the. The label/buildnumber will be out- of- sync by 1 for every concurrent Ant build failure, i. Cruisecontrol will have label X, but the propertyfile will actually have the value X+3.
The recommendation is therefore. Cruisecontrol to re- read the property file for all builds by setting the value. Build. Incrementer attribute to true. Attributes. Attribute. Required. Descriptiondefaultlabel. Novalue to return if property file doesn't exist. Build. Incrementer.
No. If true the property will be re- read from the property file prior to the build attempt and thus each build attempt will have the latest value of the propertypropertyfile. Yesthe property file to read. Yesthe name of the property to read for the value of the label. Returns a value for the label based on the SVN revision number. Attributes. Attribute.
Required. Descriptionworkingcopypath. No (defaults to .)Path to the SVN working copylabelprefix.
No (defaults to svn)Prefix for the labelseparator. No (defaults to .)The separator to use between label and build counttop.
Copies the XML log file from the build, and all files published by. FTP server. To publish the artifacts, the. Attributes. In addition to the common FTP attributes. Attribute. Required.
Descriptiondest. Dir. Yes. The remote directory (relative to target. Dir). to publish the files. Dir. Yes. To publish the XML log file, this must be the same as the dir attribute of the. To publish. the artifacts, this must be the same as the. Artifacts. No (defaults to false)If true, then all files successfully sent to. FTP server will be deleted locally.
The following attributes are common to the. Attribute. Required. Descriptiontarget. Host. Yes. Host name of the FTP server. User. No (defaults to anonymous)The user used for logging into the FTP site. Passwd. No (default to eat@joes.
The password used during FTP log in for the. User. target. Port. No (defaults to 2. Port number of the FTP server. Dir. No (defaults to '.')Base directory in the FTP server to put the files. Separator. No (defaults to '/'. Directory separator character used by the FTP server.
The following attributes are common to the xpath aware children found in. Attribute. Required. Descriptionvalue.
One of value or xpath. Expression must be specified. A fixed value that will not change at runtime. Expression. One of value or xpath. Expression must be specified. An xpath expression to evaluate against the Cruise.
Control log file, or the xml file. File attribute. The result of the expression will be. File. No (defaults to the Cruise. Control build log). Path to a file on the local filesystem against which the.
Expression will be evaluated. The same attributes as found in the XPath Aware Child Attributes. Attribute. Required. Descriptionname. Yes The name of a field in the tracker artifact.
Several plugins require libraries to build that can't be distributed with Cruise. Control. To use these. The source for these plugins is.
To build the plugin you'll need to put the required jars for the plugin into the [name]/lib directory. After you've built the plugin you'll need to move all the files. Cruise. Control — which means just copying them to the.