DESCRIPTION

AntShield is an ant task that does two things:

1.  Displays a GUI that allows a user to set a project and release number for
    a package release, eg. "10.0.3.mas". Pre-existing projects and releases
    for the package populate a list of likely release numbers the user will
    want, based on the release type of "major", "minor" or "patch", and whether
    or not the "undo" option is set.
    In addition, the user can specify a completely new project and/or release.

2.  Displays a GUI that allows a user to set values for user-specified fields.


USAGE

1.  Put the file 'antshield.jar' in your $ANT_HOME/lib directory.  The next
    time ant is run, the AntShield task will be available.

2.  In your ant build file (eg. build.xml), add either of the following lines
    to define the AntShield task:

    <taskdef name="antshield" classname="com.erg.mass.ant.AntShield">
        or
    <taskdef resource="antshield.properties">

3.  In your ant build file, define a target to use the AntShield task, eg.

    <target name="release-major" depends="...">
        <antshield dpkgDir="H:/dpkg_archive"
                   packageName="mypackage"
                   type="major"
                   release="on"
                   releaseProperty="my.release.property">
            <field name="myfield1" prompt="My Prompt1"\>
            <field name="myfield2" prompt="My Prompt2" defaultValue="hello"\>
            <field name="myfield3" prompt="My Prompt3">
                <option value="val1"/>
                <option value="val2"/>
                <option value="val3"/>
            <\field>
        </antshield>
    </target>

4.  The user-supplied release, eg. "10.0.3.mas", is stored in the property name
    specified in the parameter releaseProperty, eg. "my.release.property".

    The user-supplied field values are stored as properties of the specified name,
    and can be accessed by ant like so:

    <dostuff param1="${myfield1}" param2="${myfield2}" param3="${myfield3}"/>
    <dorelease dir="H:/dpkg_archive/mypackage/${my.release.property}"/>


PARAMETERS

    TAG "antshield"

        PARAM "dpkgDir"  (optional, default=$JATS_HOME)
            The location of the dpkg_archive directory.

        PARAM "packageName"  (mandatory if "release" is true)
            The name of the package to be released - for existing packages,
            must be a valid subdirectory of dpkgDir, otherwise it assumes
            that a new package is being released.

        PARAM "type"         (optional, default="patch")
            The type of release - "major", "minor" or "patch".

        PARAM "release"      (optional, default="true")
            Display a release dialog.  Boolean values "true", "false", "yes",
            "no", "on" or "off".

        PARAM "releaseProperty" (optional, default="antshield.release")
            Name of the property that the user-selected release will be stored
            in.
            
        PARAM "undo" (optional, default="false")
            If true, the release dialog displays a list of existing releases.
            If false (default), a list of new releases is displayed.

        NESTED TAG "field"

            PARAM "name"         (mandatory)
                The name of the field and the property that will be set
                on completion of the AntShield task.

            PARAM "prompt"       (mandatory)
                The prompt string to display in the AntShield dialog box for
                this field.

            PARAM "defaultValue" (optional, default="")
                A default value for this field.

            NESTED TAG "option"
                If specified, a combo box is displayed for this field.

                PARAM "value"        (mandatory)
                    A value to display in the combo box for this field.

            NESTED TAG "filelist"
                If specified, a combo box is displayed for this field, populated
                with a list of specified files.  Refer to your ant documentation
                for the correct usage of this tag.

            NESTED TAG "fileset"
                If specified, a combo box is displayed for this field, populated
                with the results of the specified FileSet.  Refer to your ant
                documentation for the correct usage of this tag.

            NESTED TAG "dirset"
                If specified, a combo box is displayed for this field, populated
                with the results of the specified DirSet.  Refer to your ant
                documentation for the correct usage of this tag.

END