Skip to Content
Version 20.1 by michaelsd on 2012/07/01 11:35
Show last authors
1 {{tip title="Pro Tip"}}
2 If you use Hudson/Jenkins to build your WebObjects Frameworks and Applications, then you do not need to build or install either the Project Wonder frameworks or even your own Frameworks on your development machine, just having yours and the individual Wonder source code projects (ERJars, ERExtensions, AJAX, etc) open in your eclipse workspace is sufficient.
3 {{/tip}}
4
5 {{toc maxLevel="3"}}{{/toc}}
6
7 = Before You Build =
8
9 When building a Framework project, Ant needs to be able to find WebObjects. WebObjects itself is a set of Frameworks just like the one you are building. They can be installed anywhere using [[these instructions>>WO:Installing WebObjects 5.4 on Snow Leopard]].
10
11 Where Ant will look for WebObjects is specified by the ##wo.system.frameworks## build property. This property can be set in a number of locations, or even passed as a command-line property to Ant.
12
13 Where Ant looks for this property is different for each method of building a Framework:
14
15 1. h6. WOJenkins Jobs
16 11. Completely managed for you by WOJenkins
17 11. Manually overridden as defined in Manual Jenkins Jobs below.
18 1. h6. Manual Jenkins Jobs
19 11. Properties specified in the //Targets// line of an Invoke Ant build task using **##-D<property>=<value>##**
20 11. Properties specified in the //Properties// line of an Invoke Ant build task using (the equivalent of **##-propertyfile <name>##**)
21 1. h6. Eclipse/WOLips
22 11. Properties specified for the Eclipse Workspace under Eclipse -> Preferences -> WOLips - > **System Frameworks**
23 11. The ##build.properties## file in the same directory as the build.xml file as specified by **##<property file="build.properties" />##** task in the build.xml file.
24 1. h6. Command Line
25 11. Properties specified in the Ant command: **##-D<property>=<value>##**
26 11. A properties file specified in the Ant command: **##-propertyfile <name>##**
27 11. The ##build.properties## file in the same directory as the build.xml file as specified by **##<property file="build.properties" />##** task in the build.xml file.
28
29 {{note title="Can"}}
30
31 If Ant can't find the WebObjects frameworks, you will get compiler errors like this:
32 {noformat}
33 [wocompile] /MyProjects/MyFramework/Sources/com/mycompany/myapp/myclass:10:
34 package com.webobjects.appserver does not exist
35 [wocompile] import com.webobjects.appserver.WOContext;
36 {noformat}
37
38 {{/note}}
39
40 = Building =
41
42 === WOJenkins ===
43
44 Using Jenkins is the recommended way to build a Framework and WOJenkins makes the process almost as easy as building from within Eclipse/WOLips.
45
46 === Eclipse/WOLips ===
47
48 * h5. Standard WebObjects Framework
49 Right-Click on your project in Eclipse and select **WOLips Ant Tools > Install**
50 [[image:WOLipsAntInstall.png||border="1"]]
51 This will build and install the framework in the location defined in the WOLips preferences, overwriting any previously installed version of the framework.
52
53 * h5. Project Wonder Frameworks
54 **You can not build projects from Wonder this way.** You must either use the command line or Hudson/Jenkins methods
55
56 === Command Line / Terminal ===
57
58 You have to install woproject.jar first and make it available for ant before the following instructions will work. (see [[Building a WebObjects Project||anchor="Overview"]] first)
59
60 * h5. Standard WebObjects Framework
61 You can build a standard WebObjects Framework project by calling Ant and passing it the Project directory, and the name of the build target contained in the build.xml file at your project's root.
62
63 {{code value="none"}}
64
65 cd /my/project/
66 ant build
67
68 {{/code}}
69
70 By default, the built framework will be put in a ##dist## directory in your project's root.
71
72 * h5. Project Wonder Frameworks
73 This assumes that you have already downloaded the Wonder source code. Make a note of the location of the Wonder directory.
74 If you are building Project Wonder's frameworks you will use these commands instead:
75
76 {{code value="none"}}
77
78 cd /path/to/Wonder
79 ant frameworks
80
81 {{/code}}
82
83 By default, all the Wonder frameworks will be built to (##/Roots##) (in your home directory).
84
85 = Customizing the Build =
86
87 By modifying the values in the build.properties and wolips.properties files or by passing in arguments to the Ant command, you can change where Ant will look for dependencies (binary frameworks, libraries, etc.) and where it will install the build products.
88
89 = Installing =
90
91 Assuming you already cloned and built Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
92
93 ===== Install the frameworks =====
94
95 {{code value="none"}}
96 sudo ant frameworks.install
97 {{/code}}
98
99 This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
100
101 * Mac OS X: ##/Library/Framworks/##
102 * Linux: ##/Local/Library/Frameworks##
103
104 You can combine the build and install steps by simply executing this Ant command:
105
106 {{code value="none"}}
107 sudo ant frameworks frameworks.install
108 {{/code}}
109
110 === Upgrading ===
111
112 This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build.
113
114 1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
115
116 {{code value="none"}}
117 cd /path/to/WonderSource
118 {{/code}}
119
120 1. h5. Pull the changes you do not have and merge them with your local repository
121
122 {{code value="none"}}
123 git pull
124 {{/code}}
125
126 1. h5. Build the frameworks.
127
128 {{code value="none"}}
129 ant frameworks
130 {{/code}}
131
132 1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
133
134 {{code value="none"}}
135 cd ~/Roots/
136 {{/code}}
137
138 1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
139
140 {{code value="none"}}
141 for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
142 {{/code}}