This page describes how to configure an NAnt builder for a Job.
When creating a new Job or configuring an existing one, you need to specify which builder should be used for executing the Job's builds. If you specify an Ant, Grails or Maven builder, you will also need to choose a JDK.
When creating a new Plan, you must specify a builder, which will used for the Plan's Default Job.
A builder is a 'build tool' external to Bamboo. Build tools are difficult to define, since the range of features can differ significantly from one build tool to the next. In essence though, a build tool is a source code compiling utility that generates compiled executable files (referred to as artifacts in Bamboo). Build tools typically have their own form of scripting language and an ability to manage dependencies correctly. Bamboo supports multiple builders. Once a builder is defined in the Bamboo system, it can then be specified in Plans and Jobs by a Bamboo administrator.
Configuring a NAnt Builder for a Job
To configure a NAnt builder for a Job:
If you are creating a new Plan or new Job, start at step 2.
- Navigate to the Job's configuration pages, as described on Editing a Job.
- In the 'Builder' dropdown, select the NAnt builder that you wish to configure for this plan (e.g. "NAnt"). The builder that you select will become one of the plan's capability requirements. For details please see Configuring a Job's Requirements.
Tip: If you want to configure a new shared local builder capability in Bamboo, you can do so by clicking the 'Add New Builder' link and entering the builder details in the window that displays. Once you have added the new builder, it will be available for you to select from the 'Builder' dropdown.
- The screen will refresh to display the builder settings specific to NAnt:
- If required, update the system environment variables and working directory settings:
- 'Environment Variables' (Optional) — Specify any additional* operating system environment variables you want to pass to your build; Please note, multiple variables must be separated with spaces, and parameters with spaces must be quoted (e.g 'ANT_OPTS=-Xms200m -Xmx700m'). You can also include Bamboo global or build-specific variables (see Using Global or Build-specific Variables).
* i.e. additional to the existing environment variables (see Viewing Bamboo's System Information for a list). Note that existing environment variables are automatically available to the builder, thus you don't need to specify them in the 'System Environment Variables' field.
- 'Working Sub Directory' (Optional) — A subdirectory relative to the Job build's root directory where Bamboo will execute your specified builder's commands. The Job build's root directory contains everything checked out from your Job's configured source repository. If you leave this field blank, Bamboo will look for the build files in the build root directory (which is assumed to be the Job build's Working Directory, as described in Locating Important Directories and Files). This option is useful, if your Job has a build script in a subdirectory and the builder needs to be run from within that subdirectory, in which case, you would type the name of that subdirectory in this field.
- Update the following build parameters:
- 'The build will produce XYZ test results' — Select the relevant check boxes (where XYZ is NUnit, MBUnit or MSTest) if you want Bamboo to gather test results data for each build result.
Bamboo requires test results to be XML files that are compatible with NUnit, MBUnit or MSTest result file formats.
If one of these check boxes is selected, the following associated field will appear:
- 'XYZ Test Results File/Directory' (where XYZ is NUnit, MBUnit or MSTest) — Type the name of the test results directory (or multiple directories, separated by commas). You can also use Ant-style patterns such as
**/test-reports/*.xml. Please specify file path relative to your Job build's root directory — do not specify an absolute path like /home/bamboouser/bamboo-home/xml-data/build-dir/JOB_KEY/.
Have you been creating a new Plan or new Job until now?
'
Override default build hanging detection' — Select this check box if you want to override the
default build hanging detection settings. These settings determine when a build hung event is thrown (e.g. you can
configure your notifications to trigger from this event). If selected, the following options will appear:
- 'Build Time Multiplier' — This setting is used to calculate the 'Expected Build Time' for the build (i.e. 'Expected Build Time' = 'Build Time Multiplier' multiplied by 'Average Build Time').
The 'Average Build Time' is calculated by Bamboo by using an average of previous build times.
- 'Log Quiet Time' — This is the amount of time since Bamboo last recorded an entry in the build log for a build.
The 'Expected Build Time' and 'Log Quiet Time' must both be exceeded for Bamboo to throw the build hung event.
- 'Build Queue Timeout' — This is the amount of time that a build will wait in a build queue before an timeout event is thrown. Setting this value will override the global build queue timeout setting (see Configuring the Job Build Queue Timeout Event).
- 'NCover output will be produced' — Select this check box if you are running the NCover code coverage tool and want to view its code-coverage data from within Bamboo. The following field will be displayed:
- 'NCover XML Directory' — Specify the location where Bamboo will look for the XML report output file from NCover. Ensure that you specify file path relative to your Job build's root directory.
Please do not specify an absolute path like /home/bamboouser/bamboo-home/xml-data/build-dir/JOB_KEY/
- 'Use Clover to collect Code Coverage for this build' — Do not select this option. Clover now only supports builders of Java-/Groovy-based projects, such as Ant, Maven or Grails.
Click the 'Save' button to save your changes.
注意
Specifying a Builder
Editing a Job