Overview

As the local build script does not have access to the resources configured on your pulse™ server, you may need to provide this information via an XML configuration file. Note that in many cases the local build script will discover the resources for you, so you should try running a local build first and only create a resources XML file if you need to.

Resource Files

Resources may be configured using a simple XML file format. A sample resources file is shown below:

<?xml version="1.0"?>
<resources>
    <require name="automake" version="1.4"/>

    <resource name="automake">
        <!-- Properties for version 1.4 -->
        <version value="1.4">
            <property name="automake.home.dir" value="/usr/local/automake-1.4"/>
            <property name="automake.bin" value="/usr/local/automake-1.4/bin/automake"/>
        </version>
    </resource>

    <resource name="my-tool">
        <!-- Properties when no version is specified -->
        <property name="my.tool.bin" value="/usr/bin/my-tool2"/>

        <!-- Properties for version 1.0 -->
        <version value="1.0">
            <property name="my.tool.bin" value="/usr/bin/my-tool1"/>
        </version>

        <!-- Properties for version 2.0 -->
        <version value="2.0">
            <property name="my.tool.bin" value="/usr/bin/my-tool2"/>
        </version>
    </resource>
</resources>

This file defines two resources, "automake" and "my-tool". The "automake" resource has a single version, "1.4", with two properties. The "my-tool" resource has two versions, "1.0" and "2.0", each of which define the property "my.tool.bin". The default version for "my-tool" also includes this property.

Note that the file also defines a requirement for "automake" version "1.4". Requirements defined within resource XML files will apply to all builds that load the file. If you wish to reuse the same resource XML file for builds with varied requirements, those requirements should be specified to the build using the -q command-line flag.

Resource File Reference

The syntax for resource files is defined in the following pages:

• Local Build require Element
• Local Build resource Element
  • Local Build property Element
  • Local Build version Element

Invoking a Local Build With Resources

To pass your resource file to a local build, use the -e flag. For example:

$ pulse local -e resources.xml
pulse file      : 'pulse.xml'
output directory: 'pulse.out'
resources file  : 'resources.xml'
...

To also specify a requirement on a specific resource and version, use the -q flag:

$ pulse local -e resources.xml -q my-tool/1.0
pulse file      : 'pulse.xml'
output directory: 'pulse.out'
resources file  : 'resources.xml'
...