Wiki source code of Building WOLips

Version 77.1 by ava on 2010/02/05 02:19

Hide last authors
ava 76.1 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
Pascal Robert 51.1 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.
David Avendasora 39.1 8
wessman 57.1 9 WOLips is now located in Subversion at ##objectstyle.org##. The CVS repository at sourceforge is now deprecated.
Pascal Robert 51.1 10
Pascal Robert 58.1 11 The subversion repository path is https:~/~/svn.objectstyle.org/repos/woproject
wessman 57.1 12
ava 76.1 13 == Prerequisites ==
Pascal Robert 51.1 14
ava 76.1 15 ==== Install Subclipse (the Subversion plugins) ====
16
Pascal Robert 56.1 17 1. Help=>Software Updates=>Find and Install ...
18 1. Add New Remote Site
19 11. Name = Subclipse
Pascal Robert 58.1 20 11. URL = http:~/~/subclipse.tigris.org/update_1.0.x
Pascal Robert 56.1 21 1. Select the site, select all the plugins available, and install them
22
ava 76.1 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
David Avendasora 39.1 36 == Checking out and Building from the Commandline ==
37
Pascal Robert 51.1 38 1. Checkout the ##trunk/woproject## folder from Subversion
David Avendasora 62.1 39 ##svn co https:~/~/svn.objectstyle.org/repos/woproject/trunk .##
Pascal Robert 51.1 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
Pascal Robert 58.1 43 1. Edit ##,,/Library/wobuild.properties,,##
Pascal Robert 51.1 44 1. Add a line: ##eclipse.home=/path/to/your/eclipse##
Pascal Robert 52.1 45 1. ant again and it should succeed this time
Pascal Robert 58.1 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.//
Pascal Robert 51.1 47 1. The build went into ##temp/dist##
David Avendasora 39.1 48 1. Profit
pyu 60.1 49 1. [[Installing WOLips]]
David Avendasora 39.1 50
51 == Checking out and Building inside of Eclipse for Deployment ==
52
Pascal Robert 58.1 53 1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
wessman 57.1 54 1. In SVN perspective, browse WOLips repository on HEAD, checkout ##trunk/woproject##
Pascal Robert 51.1 55 1. Right-click (or equiv) on the ##build.xml## inside of the "woproject" project and Run As=>Ant Build ...
56 1. Switch to the Properties tab and check for the definition of eclipse.home in the Properties list
57 1. If ##eclipse.home## does not exist, uncheck "Use global properties" and then click "Add Property"
ava 76.1 58 1. In the Add Property dialog, make the name ##eclipse.home##, click Add Variable, select ##eclipse//home//##// from the list, and click OK//
Pascal Robert 51.1 59 1. Click Apply to save your changes
David Avendasora 39.1 60 1. Run
Pascal Robert 51.1 61 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.
pyu 60.1 62 1. [[Installing WOLips]]
David Avendasora 39.1 63
64 == Checking out and Building inside of Eclipse for Development (PDE) ==
65
Pascal Robert 58.1 66 1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
Pascal Robert 51.1 67 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]].
David Avendasora 39.1 68
Pascal Robert 51.1 69 == An approach to setting up the development and test environment for WOLips Plugin. ==
70
71 In order to do WOLips Plugin development you will need two eclipse environments: Development and Test.
72
73 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.
74 1. the ##temp/dist## folder is your Local Site for the Test Environment.
75 1. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where). This will be your Test Environment.
76 1. In the test environment, follow the [[Installing WOLips]] instructions, using your ##temp/dist## directory as the Local Site. Install the plugins.
77 1. Use the Test environment to exercise/test the changes from your locally modified Plugin.
78
ava 76.1 79 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.**
Quinton Dolan 72.1 80
81 == Building WOLips with Hudson Continuous Build server ==
82
83 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.
84
85 1. Add a new job with the following configuration
86 Project Name: WOLips
87 Subversion: http:~/~/svn.objectstyle.org/repos/woproject/trunk/woproject
88 Local module directory (optional): wolips
89 Use update: Checked
ava 76.1 90 Poll SCM: 59 * ** * ** //(59 can be replaced with any number between 0 and 59)//
Quinton Dolan 72.1 91 1. Add the following build tasks to the job
92
93 {{code title="Execute Shell"}}
94
95 echo build.version=3.4.${SVN_REVISION} > wolips/build.properties
96 echo eclipse.home=/usr/local/eclipse >> wolips/build.properties
97 echo user.home=${WORKSPACE} >> wolips/build.properties
98
99 {{/code}}
100
101 {{code title="Invoke Ant"}}
102
103 Targets: dist
104
105 {{/code}}
106
Quinton Dolan 74.1 107 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
108
109 {{code title="Execute Shell"}}
110
111 rm -fr /usr/local/www/apache22/data/wolips/*
112 /bin/cp -prv ${WORKSPACE}/wolips/temp/dist/ /usr/local/www/apache22/data/wolips/
113
114 {{/code}}
115
Quinton Dolan 72.1 116 1. Copy eclipse with the necessary plugins installed to your build server. In this example it has been copied to /usr/local/eclipse
117 The currently required plugins for a deployment build are
118
119 *
120 ** JProfiler
121 ** m2Eclipse Maven
ava 76.1 122
123 == Preparation for building WOLips on Windows operating systems (NT 5.0 and higher) ==
124
125 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.
126
127 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.
128 1. Set the VMs encoding to MacRoman
129
130 *
131 ** Right click on ##build.xml## -> Properties -> JRE -> VM arguments
132 *** --Dfile.encoding=MacRoman--
133
134 1. Edit ##woproject/wolips/goodies/plugins/build.xml##
135
136 *
137 ** Comment out the subsequent lines (mac goodies)
138 *** <ant dir="org.objectstyle.wolips.goodies.core.mac" target="all" />
139 *** <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="all" />
140 *** <ant dir="org.objectstyle.wolips.goodies.core.mac" target="dist" />
141 *** <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="dist" />
142
143 1. Edit ##woproject/wolips/features/build.xml##
144
145 *
146 ** Comment out the subsequent lines (mac features)
147 *** <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="all" />
148 *** <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="dist" />
149
150 1. Edit ##woproject/wolips/build.xml## (you may skip this one if you've got JProfiler installed)
151
152 *
153 ** Comment out the subsequent lines
154 *** <ant dir="jprofiler" target="all" />
155 *** <ant dir="jprofiler" target="dist" />
156
157 1. Run the build