Skip to Content

Changes for page Building WOLips

Last modified by Johann Werner on 2015/02/13 01:40
From version 127.1
edited by David Avendasora
on 2009/07/02 10:03
Change comment: There is no comment for this version
To version 129.1
edited by Ray Kiddy
on 2015/02/13 01:40
Change comment: works with eclipse 4.4.1

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.kiddyr
Content
... ... @@ -1,25 +1,25 @@
1 -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.
1 +{{tip title="Not Required!"}}
2 +You do not have to build WOLips to use it. It is easily available via Eclipse's Software Update functionality. The update site is: [[http:~~/~~/wocommunity.org/wolips/3.7/stable/>>url:http://wocommunity.org/wolips/3.7/stable/||shape="rect"]]
3 +{{/tip}}
2 2  
3 -WOLips is now located in Subversion at ##objectstyle.org##. The CVS repository at sourceforge is now deprecated.
5 +{{note}}
6 +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 [[doc:Debugging WOLips]].
7 +{{/note}}
4 4  
5 -The subversion repository path is https:~/~/svn.objectstyle.org/repos/woproject
9 +Prior to building WOLips, you will want to get your dependencies installed properly. Check out the [[doc:Installing WOLips]] page for information on the dependencies for WOLips.
6 6  
7 -== Prerequisites ==
11 +(% style="color: rgb(0,0,0);" %)**Prerequisites**
8 8  
9 -==== Install Subclipse (the Subversion plugins) ====
13 +==== Install eGit or another Git client ====
10 10  
11 -1. Help=>Software Updates=>Find and Install ...
12 -1. Add New Remote Site
13 -11. Name = Subclipse
14 -11. URL = http:~/~/subclipse.tigris.org/update_1.0.x
15 -1. Select the site, select all the plugins available, and install them
15 +See [[Getting Started With Git>>doc:WEB.Getting Started with Git]] for information on how to obtain a Git client.
16 16  
17 17  ==== Install the m2eclipse plugin (Eclipse 3.5 instructions) ====
18 18  
19 19  1. Help -> Install New Software
20 -1. Click "Add..."
20 +1. Click "Add..."
21 21  11. Name = M2Eclipse
22 -11. Location = http:~/~/m2eclipse.sonatype.org/update/
22 +11. Location = [[http:~~/~~/m2eclipse.sonatype.org/update/>>url:http://m2eclipse.sonatype.org/update/||shape="rect"]]
23 23  11. Click "OK"
24 24  1. Expand "Maven Integration"
25 25  1. Select "Maven Embedder"
... ... @@ -26,74 +26,104 @@
26 26  1. Select "Maven Integration for Eclipse"
27 27  1. Click "Next>"
28 28  1. Click "Finish"
29 +(//What is the m2eclipse plugin a prerequisite for? Nothing below refers to it....//)
29 29  
30 30  == Checking out and Building from the Commandline ==
31 31  
32 -1. Checkout the ##trunk/woproject## folder from Subversion
33 -##svn co https:~/~/svn.objectstyle.org/repos/woproject/trunk .##
34 -1. ##cd woproject##
35 -1. ##ant##
36 -1. The first build will fail out telling you that it couldn't find ##wobuild.properties## ~-~- That's OK
37 -1. Edit ##,,/Library/wobuild.properties,,##
38 -1. Add a line: ##eclipse.home=/path/to/your/eclipse##
39 -1. ant again and it should succeed this time
40 -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.//
41 -1. The build went into ##temp/dist##
33 +1. Checkout the {{code language="none"}}trunk/woproject{{/code}} folder from Subversion
34 + {{code language="none"}}git clone{{/code}} [[git:~~/~~/github.com/wolips/wolips.git>>url:git://github.com/wolips/wolips.git||shape="rect"]]{{code language="none"}}{{/code}} woproject
35 +1. {{code language="none"}}cd woproject{{/code}}
36 +1. {{code language="none"}}ant{{/code}}
37 +1. The first build will fail out telling you that it couldn't find {{code language="none"}}wobuild.properties{{/code}} – That's OK
38 +1. Edit {{code language="none"}}~/Library/wobuild.properties{{/code}}
39 +1. Add a line: {{code language="none"}}eclipse.home=/path/to/your/eclipse{{/code}}
40 +1. (((
41 +Call ant with the build.version argument:
42 +
43 +{{code}}
44 +ant -Dbuild.version=x.y.z
45 +{{/code}}
46 +
47 +1. If you get the error
48 +
49 +{{code language="none"}}
50 +'build.xml:73: taskdef A class needed by class org.apache.velocity.anakia.AnakiaTask cannot be found: org/jdom/JDOMException'
51 +{{/code}}, you can do one of two things. You can build with
52 +
53 +{{code language="none"}}
54 +-Dno.docs=true
55 +{{/code}} to skip the javadoc step, or (untested) you can drop
56 +
57 +{{code language="none"}}
58 +jdom-b8.jar
59 +{{/code}} from
60 +
61 +{{code language="none"}}
62 +woproject/projects/lib
63 +{{/code}} into your
64 +
65 +{{code language="none"}}
66 +ANT_HOME/lib
67 +{{/code}} folder.
68 +)))
69 +1. The build went into {{code language="none"}}temp/dist{{/code}}
42 42  1. Profit
43 -1. [[Installing WOLips]]
44 44  
72 +(Successfully built on Ubuntu 14.04 LTS with eclipse 4.4.1, using "ant -Dbuild.version=4.4.1" as the build command. - 2015/03/12 - ray@ganymede.org with an OMG thanks to stefan.klein@buero-sde.de.)
73 +
45 45  == Checking out and Building inside of Eclipse for Deployment ==
46 46  
47 -1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
48 -1. In SVN perspective, browse WOLips repository on HEAD, checkout ##trunk/woproject##
49 -1. Right-click (or equiv) on the ##build.xml## inside of the "woproject" project and Run As=>Ant Build ...
76 +1. Add the wolips Git repository [[https:~~/~~/github.com/wolips/wolips/>>url:https://github.com/wolips/wolips/||shape="rect"]] in the Git Perspective's Repository View
77 +1. Right-click (or equiv) on the {{code language="none"}}build.xml{{/code}} inside of the "woproject" project and Run As=>Ant Build ...
50 50  1. Switch to the Properties tab and check for the definition of eclipse.home in the Properties list
51 -1. If ##eclipse.home## does not exist, uncheck "Use global properties" and then click "Add Property"
52 -1. In the Add Property dialog, make the name ##eclipse.home##, click Add Variable, select ##eclipse.home## from the list, and click OK
79 +1. If {{code language="none"}}eclipse.home{{/code}} does not exist, uncheck "Use global properties" and then click "Add Property"
80 +1. In the Add Property dialog, make the name {{code language="none"}}eclipse.home{{/code}}, click Add Variable, select {{code language="none"}}eclipse_home{{/code}} from the list, and click OK
53 53  1. Click Apply to save your changes
54 54  1. Run
55 -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.
56 -1. [[Installing WOLips]]
83 +1. Once it is complete, you may need to right-click=>refresh your project and you will have a {{code language="none"}}temp/dist{{/code}} folder with the plugin site in it.
57 57  
58 58  == Checking out and Building inside of Eclipse for Development (PDE) ==
59 59  
60 -1. Add the wolips SVN repository https:~/~/svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
61 -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]].
87 +1. Add the wolips Git repository [[https:~~/~~/github.com/wolips/wolips/>>url:https://github.com/wolips/wolips/||shape="rect"]] in the Git Perspective's Repository View
88 +1. You can select individual plugins you would like to work on by browsing to {{code language="none"}}trunk/woproject/wolips/{{/code}} in the Subversion repository and checking out the plugins you are interested in. To checkout complete sets of plugins, you could also use the [[doc:Eclipse Team Project Set]].
62 62  
63 63  == An approach to setting up the development and test environment for WOLips Plugin. ==
64 64  
65 -In order to do WOLips Plugin development you will need two eclipse environments: Development and Test.
92 +In order to do WOLips Plugin development you will need two eclipse environments: Development and Test.
66 66  
67 -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.
68 -1. the ##temp/dist## folder is your Local Site for the Test Environment.
69 -1. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where). This will be your Test Environment.
70 -1. In the test environment, follow the [[Installing WOLips]] instructions, using your ##temp/dist## directory as the Local Site. Install the plugins.
94 +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.
95 +1. the {{code language="none"}}temp/dist{{/code}} folder is your Local Site for the Test Environment.
96 +1. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where). This will be your Test Environment.
97 +1. In the test environment, follow the [[doc:Installing WOLips]] instructions, using your {{code language="none"}}temp/dist{{/code}} directory as the Local Site. Install the plugins.
71 71  1. Use the Test environment to exercise/test the changes from your locally modified Plugin.
72 72  
73 -1. When you need to repeat the process, shut down the Test Environment, delete the 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.**
100 +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.
74 74  
75 -== Building WOLips with Hudson Continuous Build server ==
102 +== Building WOLips with Jenkins Continuous Build server ==
76 76  
77 77  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.
78 78  
79 -1. Add a new job with the following configuration
80 - Project Name: WOLips
81 - Subversion: http:~/~/svn.objectstyle.org/repos/woproject/trunk/woproject
82 - Local module directory (optional): wolips
83 - Use update: Checked
84 - Poll SCM: 59 * ** * ** //(59 can be replaced with any number between 0 and 59)//
85 -1. Add the following build tasks to the job
106 +1. Install Eclipse 3.7. You need it to be able to build WOLips.
107 +1. Copy the necessary plugins from your machine to the Eclipse installation on the server. In this example it has been copied to /usr/local/eclipse
108 + The currently required plugins for a deployment build are
109 + ~* JProfiler (Update Site: [[http:~~/~~/wocommunity.org/documents/tools/jprofiler6/>>url:http://wocommunity.org/documents/tools/jprofiler6/||shape="rect"]])
110 + ~* JRebel (Update Site : [[http:~~/~~/www.zeroturnaround.com/update-site/>>url:http://www.zeroturnaround.com/update-site/||shape="rect"]])
111 +1. Create a new job in Jenkins to build WOLips. You can use the [[following sample config>>url:https://github.com/wocommunity/JenkinsJobs/tree/master/WOLips||shape="rect"]] or you can add a new job with the following configuration:
112 +11. Project Name: WOLips
113 +11. Git Repositories: git:~/~/github.com/wolips/wolips.git
114 +11. Use update: Checked
115 +11. Poll SCM: 59 * * * * //(59 can be replaced with any number between 0 and 59)//
116 +1. (((
117 +Add the following build tasks to the job
86 86  
87 87  {{code title="Execute Shell"}}
120 +echo build.version=3.7.${BUILD_NUMBER} > build.properties
121 +echo eclipse.home=/usr/local/eclipse >> build.properties
122 +echo user.home=${WORKSPACE} >> build.properties
88 88  
89 -echo build.version=3.4.${SVN_REVISION} > wolips/build.properties
90 -echo eclipse.home=/usr/local/eclipse >> wolips/build.properties
91 -echo user.home=${WORKSPACE} >> wolips/build.properties
92 -
93 93  {{/code}}
94 94  
95 95  {{code title="Invoke Ant"}}
96 -
97 97  Targets: dist
98 98  
99 99  {{/code}}
... ... @@ -101,15 +101,45 @@
101 101  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
102 102  
103 103  {{code title="Execute Shell"}}
104 -
105 105  rm -fr /usr/local/www/apache22/data/wolips/*
106 106  /bin/cp -prv ${WORKSPACE}/wolips/temp/dist/ /usr/local/www/apache22/data/wolips/
107 107  
108 108  {{/code}}
138 +)))
109 109  
110 -1. Copy eclipse with the necessary plugins installed to your build server. In this example it has been copied to /usr/local/eclipse
111 -The currently required plugins for a deployment build are
140 +== Preparation for building WOLips on Windows operating systems (NT 5.0 and higher) ==
112 112  
113 -*
114 -** JProfiler
115 -** m2Eclipse Maven
142 +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.
143 +
144 +1. Install the [[BuildingWOLips-Prerequisites>>doc:||anchor="BuildingWOLips-Prerequisites"]]. Do also follow the [[BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment>>doc:||anchor="BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment"]]section, but don't run the build until the changes described below have been made.
145 +1. Set the VMs encoding to MacRoman
146 +1*. Right click on {{code language="none"}}build.xml{{/code}} -> Properties -> JRE -> VM arguments
147 +1**. -Dfile.encoding=MacRoman
148 +1. Edit {{code language="none"}}woproject/wolips/goodies/plugins/build.xml{{/code}}
149 +1*. Comment out the subsequent lines (mac goodies)
150 +1**. <ant dir="org.objectstyle.wolips.goodies.core.mac" target="all" />
151 +1**. <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="all" />
152 +1**. <ant dir="org.objectstyle.wolips.goodies.core.mac" target="dist" />
153 +1**. <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="dist" />
154 +1. Edit {{code language="none"}}woproject/wolips/features/build.xml{{/code}}
155 +1*. Comment out the subsequent lines (mac features)
156 +1**. <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="all" />
157 +1**. <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="dist" />
158 +1. Edit {{code language="none"}}woproject/wolips/build.xml{{/code}} (you may skip this one if you've got JProfiler installed)
159 +1*. Comment out the subsequent lines
160 +1**. <ant dir="jprofiler" target="all" />
161 +1**. <ant dir="jprofiler" target="dist" />
162 +1. Run the build
163 +
164 +== Installing from a Local Build ==
165 +
166 +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
167 +1. Assuming you now have your build versions under control, you should follow the instructions for
168 +1. Launch Eclipse
169 +1. Select the menu: Help->Software Updates.
170 +1. Click on the 'Available Software' tab at the top of the window.
171 +1. Click on the 'Add Site...' button. This will bring up a dialog box.
172 +1. Click on the 'Local...' button on the dialog box.
173 +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.
174 +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.
175 +1. Then continue, and just keep selecting the "Yes"/"OK"/"Approve"/etc buttons