Skip to Content

Wiki source code of Building WOLips

Version 43.1 by mark_ritchie on 2009/09/08 23:55
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 1. [[Installing WOLips]]
50
51 == Checking out and Building inside of Eclipse for Deployment ==
52
53 1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
54 1. In SVN perspective, browse WOLips repository on HEAD, checkout ##trunk/woproject##
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"
58 1. In the Add Property dialog, make the name ##eclipse.home##, click Add Variable, select ##eclipse//home//##// from the list, and click OK//
59 1. Click Apply to save your changes
60 1. Run
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.
62 1. [[Installing WOLips]]
63
64 == Checking out and Building inside of Eclipse for Development (PDE) ==
65
66 1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
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]].
68
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
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.**
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
90 Poll SCM: 59 * ** * ** //(59 can be replaced with any number between 0 and 59)//
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
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
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