XML Definition
Builds are defined in an XML Schema file which is located at “cgi_studio_connector/schema/BuildProject.xsd”. This file can be used to validate xml files and with some editors (e.g. Visual-Studio) and provide code-completion when writing the XML file.
BuildProject-Element
Root Element. Contains list of Root-Paths, global Variables and Builds.
Attributes:
| Argument | Required | Description |
| version | Yes | Version of the Build-Project file. |
Children:
| Argument | Occurrence | Description |
| RootPaths | 1 | List of Root-Paths |
| Variables | 1 | List of global Variables. These Variables can be used in any Build. |
| Builds | 1 | List of Builds |
RootPaths-Element
Defines a list of Root-Paths.
Attributes:
None
Children:
| Argument | Occurrence | Description |
| RootPath | 0 - * | Root-Path |
Variables-Element
Defines a list of Variables.
Attributes:
None
Children:
| Argument | Occurrence | Description |
| Variable | 0 - * | Variable |
Builds-Element
Defines a list of Builds.
Attributes:
None
Children:
| Argument | Occurrence | Description |
| Build | 0 - * | Build |
RootPath-Element
Defines a Root-Path. Root-Paths can be referenced by variables to make them relative to a common path.
Attributes:
| Argument | Required | Description |
| name | Yes | Name of the Root-Path. |
| description | No | Description of the argument. |
Children:
None
Variable-Element
A variable for the build which will be applied for all executed scripts.
Attributes:
| Argument | Required | Description |
| name | Yes | Name of the variable. |
| type | Yes | Type of the variable. Valid values are ‘Value’, ‘Option’, ‘Path’ and ‘File’ |
| root_path_key | No | If set, paths (or files) will be relative to the given Root-Path. |
| value | Yes | Value of the variable. If the type is ‘Option’, valid values can be specified as a list of values separated by semicolons. If left blank, any value is considered valid. |
| description | Yes | Description of the variable. |
Children:
None
Build-Element
A build which can be executed.
Attributes:
| Argument | Required | Description |
| name | Yes | Name of the build. |
| description | Yes | Description of the build. |
Children:
| Argument | Occurrence | Description |
| ScriptPath | 1 | Path to the script files which should be executed for this build. |
| OutputPath | 1 | Output-Path for this build. |
| Variable | 0 - * | Variable for this build |
ScriptPath-Element
Path to the script files which are executed when this build is started. The script files should start with a number to indicate their execution order.
Attributes:
| Argument | Required | Description |
| value | Yes | Relative path. |
| root_path | No | If set, path will be relative to the given Root-Path. |
Children:
None
OutputPath-Element
Main output path for this build. Even if the build doesn’t produce any artifacts or generates output into other directories, at least the log file will be saved here.
Attributes:
| Argument | Required | Description |
| value | Yes | Relative path. |
| root_path | No | If set, path will be relative to the given Root-Path. |
Children:
None