| 1924 |
mhunt |
1 |
DESCRIPTION
|
|
|
2 |
|
|
|
3 |
AntShield is an ant task that does two things:
|
|
|
4 |
|
|
|
5 |
1. Displays a GUI that allows a user to set a project and release number for
|
|
|
6 |
a package release, eg. "10.0.3.mas". Pre-existing projects and releases
|
|
|
7 |
for the package populate a list of likely release numbers the user will
|
|
|
8 |
want, based on the release type of "major", "minor" or "patch", and whether
|
|
|
9 |
or not the "undo" option is set.
|
|
|
10 |
In addition, the user can specify a completely new project and/or release.
|
|
|
11 |
|
|
|
12 |
2. Displays a GUI that allows a user to set values for user-specified fields.
|
|
|
13 |
|
|
|
14 |
|
|
|
15 |
USAGE
|
|
|
16 |
|
|
|
17 |
1. Put the file 'antshield.jar' in your $ANT_HOME/lib directory. The next
|
|
|
18 |
time ant is run, the AntShield task will be available.
|
|
|
19 |
|
|
|
20 |
2. In your ant build file (eg. build.xml), add either of the following lines
|
|
|
21 |
to define the AntShield task:
|
|
|
22 |
|
|
|
23 |
<taskdef name="antshield" classname="com.erg.mass.ant.AntShield">
|
|
|
24 |
or
|
|
|
25 |
<taskdef resource="antshield.properties">
|
|
|
26 |
|
|
|
27 |
3. In your ant build file, define a target to use the AntShield task, eg.
|
|
|
28 |
|
|
|
29 |
<target name="release-major" depends="...">
|
|
|
30 |
<antshield dpkgDir="H:/dpkg_archive"
|
|
|
31 |
packageName="mypackage"
|
|
|
32 |
type="major"
|
|
|
33 |
release="on"
|
|
|
34 |
releaseProperty="my.release.property">
|
|
|
35 |
<field name="myfield1" prompt="My Prompt1"\>
|
|
|
36 |
<field name="myfield2" prompt="My Prompt2" defaultValue="hello"\>
|
|
|
37 |
<field name="myfield3" prompt="My Prompt3">
|
|
|
38 |
<option value="val1"/>
|
|
|
39 |
<option value="val2"/>
|
|
|
40 |
<option value="val3"/>
|
|
|
41 |
<\field>
|
|
|
42 |
</antshield>
|
|
|
43 |
</target>
|
|
|
44 |
|
|
|
45 |
4. The user-supplied release, eg. "10.0.3.mas", is stored in the property name
|
|
|
46 |
specified in the parameter releaseProperty, eg. "my.release.property".
|
|
|
47 |
|
|
|
48 |
The user-supplied field values are stored as properties of the specified name,
|
|
|
49 |
and can be accessed by ant like so:
|
|
|
50 |
|
|
|
51 |
<dostuff param1="${myfield1}" param2="${myfield2}" param3="${myfield3}"/>
|
|
|
52 |
<dorelease dir="H:/dpkg_archive/mypackage/${my.release.property}"/>
|
|
|
53 |
|
|
|
54 |
|
|
|
55 |
PARAMETERS
|
|
|
56 |
|
|
|
57 |
TAG "antshield"
|
|
|
58 |
|
|
|
59 |
PARAM "dpkgDir" (optional, default=$JATS_HOME)
|
|
|
60 |
The location of the dpkg_archive directory.
|
|
|
61 |
|
|
|
62 |
PARAM "packageName" (mandatory if "release" is true)
|
|
|
63 |
The name of the package to be released - for existing packages,
|
|
|
64 |
must be a valid subdirectory of dpkgDir, otherwise it assumes
|
|
|
65 |
that a new package is being released.
|
|
|
66 |
|
|
|
67 |
PARAM "type" (optional, default="patch")
|
|
|
68 |
The type of release - "major", "minor" or "patch".
|
|
|
69 |
|
|
|
70 |
PARAM "release" (optional, default="true")
|
|
|
71 |
Display a release dialog. Boolean values "true", "false", "yes",
|
|
|
72 |
"no", "on" or "off".
|
|
|
73 |
|
|
|
74 |
PARAM "releaseProperty" (optional, default="antshield.release")
|
|
|
75 |
Name of the property that the user-selected release will be stored
|
|
|
76 |
in.
|
|
|
77 |
|
|
|
78 |
PARAM "undo" (optional, default="false")
|
|
|
79 |
If true, the release dialog displays a list of existing releases.
|
|
|
80 |
If false (default), a list of new releases is displayed.
|
|
|
81 |
|
|
|
82 |
NESTED TAG "field"
|
|
|
83 |
|
|
|
84 |
PARAM "name" (mandatory)
|
|
|
85 |
The name of the field and the property that will be set
|
|
|
86 |
on completion of the AntShield task.
|
|
|
87 |
|
|
|
88 |
PARAM "prompt" (mandatory)
|
|
|
89 |
The prompt string to display in the AntShield dialog box for
|
|
|
90 |
this field.
|
|
|
91 |
|
|
|
92 |
PARAM "defaultValue" (optional, default="")
|
|
|
93 |
A default value for this field.
|
|
|
94 |
|
|
|
95 |
NESTED TAG "option"
|
|
|
96 |
If specified, a combo box is displayed for this field.
|
|
|
97 |
|
|
|
98 |
PARAM "value" (mandatory)
|
|
|
99 |
A value to display in the combo box for this field.
|
|
|
100 |
|
|
|
101 |
NESTED TAG "filelist"
|
|
|
102 |
If specified, a combo box is displayed for this field, populated
|
|
|
103 |
with a list of specified files. Refer to your ant documentation
|
|
|
104 |
for the correct usage of this tag.
|
|
|
105 |
|
|
|
106 |
NESTED TAG "fileset"
|
|
|
107 |
If specified, a combo box is displayed for this field, populated
|
|
|
108 |
with the results of the specified FileSet. Refer to your ant
|
|
|
109 |
documentation for the correct usage of this tag.
|
|
|
110 |
|
|
|
111 |
NESTED TAG "dirset"
|
|
|
112 |
If specified, a combo box is displayed for this field, populated
|
|
|
113 |
with the results of the specified DirSet. Refer to your ant
|
|
|
114 |
documentation for the correct usage of this tag.
|
|
|
115 |
|
|
|
116 |
END
|