Skip to Content

Wiki source code of Building WOLips

Version 59.1 by Pascal Robert on 2010/10/03 00:40
Show last authors
1 {{note}}
2
3 The following instructions about building WOLips are fine if you need to build a distribution of WOLips. However, they aren't so great if you're debugging WOLips. Instructions on how to do that are posted here [Debugging WOLips].
4
5 {{/note}}
6
7 Prior to building WOLips, you will want to get your dependencies installed properly. Check out the [[Installing WOLips]] page for information on the dependencies for WOLips.
8
9 WOLips is now located in Subversion at ##objectstyle.org##. The CVS repository at sourceforge is now deprecated.
10
11 The subversion repository path is https:~/~/svn.objectstyle.org/repos/woproject
12
13 == Prerequisites ==
14
15 ==== Install Subclipse (the Subversion plugins) ====
16
17 1. Help=>Software Updates=>Find and Install ...
18 1. Add New Remote Site
19 11. Name = Subclipse
20 11. URL = http:~/~/subclipse.tigris.org/update_1.0.x
21 1. Select the site, select all the plugins available, and install them
22
23 ==== Install the m2eclipse plugin (Eclipse 3.5 instructions) ====
24
25 1. Help -> Install New Software
26 1. Click "Add..."
27 11. Name = M2Eclipse
28 11. Location = http:~/~/m2eclipse.sonatype.org/update/
29 11. Click "OK"
30 1. Expand "Maven Integration"
31 1. Select "Maven Embedder"
32 1. Select "Maven Integration for Eclipse"
33 1. Click "Next>"
34 1. Click "Finish"
35
36 == Checking out and Building from the Commandline ==
37
38 1. Checkout the ##trunk/woproject## folder from Subversion
39 ##svn co https:~/~/svn.objectstyle.org/repos/woproject/trunk .##
40 1. ##cd woproject##
41 1. ##ant##
42 1. The first build will fail out telling you that it couldn't find ##wobuild.properties## ~-~- That's OK
43 1. Edit ##,,/Library/wobuild.properties,,##
44 1. Add a line: ##eclipse.home=/path/to/your/eclipse##
45 1. ant again and it should succeed this time
46 11. If you get the error ##'build.xml:73: taskdef A class needed by class org.apache.velocity.anakia.AnakiaTask cannot be found: org/jdom/JDOMException'##, you can do one of two things. You can build with ##-Dno.docs=true## to skip the javadoc step, or (untested) you can drop ##jdom-b8.jar## from ##woproject/projects/lib## into your ##ANT//HOME/lib//##// folder.//
47 1. The build went into ##temp/dist##
48 1. Profit
49
50 == Checking out and Building inside of Eclipse for Deployment ==
51
52 1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
53 1. In SVN perspective, browse WOLips repository on HEAD, checkout ##trunk/woproject##
54 1. Right-click (or equiv) on the ##build.xml## inside of the "woproject" project and Run As=>Ant Build ...
55 1. Switch to the Properties tab and check for the definition of eclipse.home in the Properties list
56 1. If ##eclipse.home## does not exist, uncheck "Use global properties" and then click "Add Property"
57 1. In the Add Property dialog, make the name ##eclipse.home##, click Add Variable, select ##eclipse//home//##// from the list, and click OK//
58 1. Click Apply to save your changes
59 1. Run
60 1. Once it is complete, you may need to right-click=>refresh your project and you will have a ##temp/dist## folder with the plugin site in it.
61
62 == Checking out and Building inside of Eclipse for Development (PDE) ==
63
64 1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
65 1. You can select individual plugins you would like to work on by browsing to ##trunk/woproject/wolips/## in the Subversion repository and checking out the plugins you are interested in. To checkout complete sets of plugins, you could also use the [[Eclipse Team Project Set]].
66
67 == An approach to setting up the development and test environment for WOLips Plugin. ==
68
69 In order to do WOLips Plugin development you will need two eclipse environments: Development and Test.
70
71 1. Follow the Checking out and Building inside of Eclipse for Deployment in you primary Eclipse installation (i.e. /Application/eclipse) and workspace. This will be you development environment.
72 1. the ##temp/dist## folder is your Local Site for the Test Environment.
73 1. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where). This will be your Test Environment.
74 1. In the test environment, follow the [[Installing WOLips]] instructions, using your ##temp/dist## directory as the Local Site. Install the plugins.
75 1. Use the Test environment to exercise/test the changes from your locally modified Plugin.
76
77 1. When you need to repeat the process, shut down the Test Environment, delete the org.objectstyle.** files in the features and plugins directories under the /Users/<me>/Developer/eclipse directory. Change the source code in the primary environment and build. (Each build took 3 min 37+ seconds on my Mac Book Pro 17"). Once the build is done, then reinstall the plugin in the Test Environment. The Local Site should still be selected.**
78
79 == Building WOLips with Hudson Continuous Build server ==
80
81 Hudson is a Java base continuous build server that allows you to build and test your project automatically. It can be easily configured to build WOLips in a few simple steps.
82
83 1. Add a new job with the following configuration
84 Project Name: WOLips
85 Subversion: http:~/~/svn.objectstyle.org/repos/woproject/trunk/woproject
86 Local module directory (optional): wolips
87 Use update: Checked
88 Poll SCM: 59 * ** * ** //(59 can be replaced with any number between 0 and 59)//
89 1. Add the following build tasks to the job
90
91 {{code title="Execute Shell"}}
92
93 echo build.version=3.4.${SVN_REVISION} > wolips/build.properties
94 echo eclipse.home=/usr/local/eclipse >> wolips/build.properties
95 echo user.home=${WORKSPACE} >> wolips/build.properties
96
97 {{/code}}
98
99 {{code title="Invoke Ant"}}
100
101 Targets: dist
102
103 {{/code}}
104
105 If you want to deploy the build to a web server to serve as an update site add a task that is something like this
106
107 {{code title="Execute Shell"}}
108
109 rm -fr /usr/local/www/apache22/data/wolips/*
110 /bin/cp -prv ${WORKSPACE}/wolips/temp/dist/ /usr/local/www/apache22/data/wolips/
111
112 {{/code}}
113
114 1. Copy eclipse with the necessary plugins installed to your build server. In this example it has been copied to /usr/local/eclipse
115 The currently required plugins for a deployment build are
116
117 *
118 ** JProfiler
119 ** m2Eclipse Maven
120
121 == Preparation for building WOLips on Windows operating systems (NT 5.0 and higher) ==
122
123 For building WOLips on Windows operating systems, some minor changes have to be made. Instead of following and solving the build errors, you may follow the steps described below.
124
125 1. Install the [[||anchor="BuildingWOLips-Prerequisites"]]. Do also follow the [[||anchor="BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment"]] section, but don't run the build until the changes described below have been made.
126 1. Set the VMs encoding to MacRoman
127
128 *
129 ** Right click on ##build.xml## -> Properties -> JRE -> VM arguments
130 *** --Dfile.encoding=MacRoman--
131
132 1. Edit ##woproject/wolips/goodies/plugins/build.xml##
133
134 *
135 ** Comment out the subsequent lines (mac goodies)
136 *** <ant dir="org.objectstyle.wolips.goodies.core.mac" target="all" />
137 *** <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="all" />
138 *** <ant dir="org.objectstyle.wolips.goodies.core.mac" target="dist" />
139 *** <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="dist" />
140
141 1. Edit ##woproject/wolips/features/build.xml##
142
143 *
144 ** Comment out the subsequent lines (mac features)
145 *** <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="all" />
146 *** <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="dist" />
147
148 1. Edit ##woproject/wolips/build.xml## (you may skip this one if you've got JProfiler installed)
149
150 *
151 ** Comment out the subsequent lines
152 *** <ant dir="jprofiler" target="all" />
153 *** <ant dir="jprofiler" target="dist" />
154
155 1. Run the build
156
157 == Installing from a Local Build ==
158
159 1. If you made changes locally, Eclipse will not automatically install your changed plugins if the version number is the same. You have two options - either uninstall WOLips or cheat and increment the WOLips build version prior to building your local copy. To uninstall WOLips, just delete all org.objectstyle features and plug ins from your eclipse folder. To increment the build server version, open buildserver.version in your projects folder and increment the last number. Note that you will now be "competing" with version numbers from the official build server, so the next official build will not install because you already used the next number, but sometimes it's a quick hack to force an update if you're lazy :-)
160 1. Assuming you now have your build versions under control, you should follow the instructions for [[Building WOLips]]
161 1. Launch Eclipse
162 1. Select the menu: Help->Software Updates.
163 1. Click on the 'Available Software' tab at the top of the window.
164 1. Click on the 'Add Site...' button. This will bring up a dialog box.
165 1. Click on the 'Local...' button on the dialog box.
166 1. Browse to and select your workspace/projects/temp/dist folder or your woproject/temp/dist folder (depending on whether you checked out in eclipse or command line). Check the box next to it.
167 1. If you updated the version number in your local copy (instead of uninstalling), you must now click on the 'Installed Software' tab at the top of the window and click on the 'Update...' button.
168 1. Then continue, and just keep selecting the "Yes"/"OK"/"Approve"/etc buttons