BatBuilder
A simple Builder to interface with Windows batch script based builds
Overview
BatBuilder:
A simple Builder to interface with Windows batch script based builds
Design
- Super Type
- Builder
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | Builder |
Constraints
Allowed Child Dependencies
- BuilderBuildFile1
- BuilderBuildTarget1
- BuilderImportMax1
- BuilderImportMin1
- BuilderNotificationList1
- BuilderPackageExtension1
- BuilderPackageFilebase1
- BuilderPackageInstallroot1
- BuilderPackageRequireBuildstamp1
- BuilderPackageSeparator1
- BuilderPackageType1
- BuilderPackageVersion1
- BuilderPath1
- BuilderScmBinding1
- BuilderScmConnection1
- BuilderScmLabel1
- BuilderScmModule1
- BuilderVersionBuild1
- BuilderVersionMajor1
- BuilderVersionMinor1
- BuilderVersionRelease1
- CruiseControlInterval1
- CruiseControlMailHost1
- CruiseControlReturnAddress1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- CruiseControl
- Node
- Updater
Attributes
Exported Attributes
| Name | Property |
|---|---|
| basedir | deployment-basedir |
| targetdir | deployment-install-root |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| buildFile | build.bat |
| buildPath | |
| buildTarget | |
| cruiseControlInterval | 300 |
| importMax | 1 |
| importMin | 1 |
| packageExtension | war |
| packageFilebase | .*? |
| packageSeparator | - |
| packageType | war |
| requireBuildstamp | false |
| scmBinding | cvs |
| scmLabel |
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
Build
Run the build cycle.
- Usage
- Build [-buildstamp <>]
Workflow
- scmCheckout
- runBuildScript
Options
| Option | Description |
|---|---|
| buildstamp | build identifier |
runBuildScript
runs the build script
- Usage
- runBuildScript [-basedir <>] [-buildfile <>] [-buildstamp <>] [-path <>] [-target <>] [-targetdir <>]
Options
| Option | Description |
|---|---|
| basedir | directory where build resources reside |
| buildfile | build file to execute |
| buildstamp | build identifier |
| path | System path to use for build |
| target | build target to evaluate |
| targetdir | directory build artifacts will be written |
Import
Import a set of packages.
- Usage
- Import [-buildstamp <>]
Workflow
- repoImport
Options
| Option | Description |
|---|---|
| buildstamp | build identifier |
generateProject
Generate a CruiseControl project definition for inclusion in config.xml
- Usage
- generateProject [-basedir <>] -file <> [-interval <>] [-mailhost <>] [-notificationlist <>] [-project <${context.name}>] [-returnaddress <>]
Options
| Option | Description |
|---|---|
| basedir | directory where build resources reside |
| file | The project absolute path of the file to generate for inclusion by CruiseControl |
| interval | Minimum duration between builds in seconds |
| mailhost | CruiseControl mail server address |
| notificationlist | Comma separated list of email addresses to be notified about the build |
| project | Name of the CruiseControl project to generate |
| returnaddress | CruiseControl returned mail address |