Changes for page Building WOLips
Last modified by Johann Werner on 2015/02/13 01:40
From version 117.1
edited by Mike Schrag
on 2005/07/19 22:15
on 2005/07/19 22:15
Change comment:
There is no comment for this version
To version 119.1
edited by Pascal Robert
on 2011/09/18 12:18
on 2011/09/18 12:18
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. mschrag1 +XWiki.probert - Content
-
... ... @@ -1,112 +1,164 @@ 1 +{{warning}} 2 +Since WOLips moved away to GitHub, this page needs some reworking. In the meantime, please adapt your build procedure to use Git instead of SVN. 3 + 4 +{color:#333333}WOLips is now located GitHub at {color}{color:#006daf}[https://github.com/wolips/wolips/]{color}. The SVN repository at objectstyle is now deprecated. 5 +{{/warning}} 6 + 7 +{{tip title="Not Required!"}} 8 +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://webobjects.mdimension.com/hudson/job/WOLips37Current/lastSuccessfulBuild/artifact/site/] 9 +{{/tip}} 10 + 11 +{{note}} 12 + 13 +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]. 14 + 15 +{{/note}} 16 + 17 +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. 18 + 19 +{{color value="#000000"}} 20 +{*}Prerequisites{*} 21 +{{/color}} 22 + 23 +==== Install eGit or another Git client ==== 24 + 25 +See [[Getting Started With Git>>WO:Getting Started with Git]] for information on how to obtain a Git client. 26 + 27 +==== Install the m2eclipse plugin (Eclipse 3.5 instructions) ==== 28 + 29 +1. Help > Install New Software 30 +1. Click "Add..." 31 +11. Name = M2Eclipse 32 +11. Location = [[http://m2eclipse.sonatype.org/update/]] 33 +11. Click "OK" 34 +1. Expand "Maven Integration" 35 +1. Select "Maven Embedder" 36 +1. Select "Maven Integration for Eclipse" 37 +1. Click "Next>" 38 +1. Click "Finish" 39 + 1 1 == Checking out and Building from the Commandline == 2 2 3 -1. cvs --d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/woproject login-- 4 -11. username = anonymous 5 -11. no password 6 -1. cvs --d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/woproject co woproject-- 7 -1. cd woproject/projects 8 -1. ant 9 -1. The first build will fail out telling you that it couldn't find wobuild.properties ~-~- That's OK 10 -1. Edit ,,/Library/wobuild.properties,, 11 -1. Add a line eclipse.home=/path/to/your/eclipse 12 -1. ant again and it should succeed this time 13 -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.// 14 -1. The build went into temp/dist 42 +1. Checkout the ##trunk/woproject## folder from Subversion 43 +##git clone## ##[[git://github.com/wolips/wolips.git]]## woproject 44 +1. ##cd woproject## 45 +1. ##ant## 46 +1. The first build will fail out telling you that it couldn't find ##wobuild.properties## ~-~- That's OK 47 +1. Edit ##/Library/wobuild.properties## 48 +1. Add a line: ##eclipse.home=/path/to/your/eclipse## 49 +1. Call ant with the build.version argument: 50 + 51 +{{code}} 52 +ant -Dbuild.version=3.7.SomeNumber 53 +{{/code}} 54 + 55 +1. 56 +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.// 57 +1. The build went into ##temp/dist## 15 15 1. Profit 16 -1. [[Installing WOLips]] 17 17 18 18 == Checking out and Building inside of Eclipse for Deployment == 19 19 20 -1. install jmechanic plugin from [[The JMechanic Site>>http://sourceforge.net/project/showfiles.php?group_id=68316&release_id=136699]] 21 -11. just untar this into your plugins folder 22 -1. Add the wolips CVS repository 23 -11. host = cvs.sourceforge.net 24 -11. root = /cvsroot/woproject 25 -11. protocol = pserver 26 -11. login = anonymous 27 -11. no password 28 -1. In CVS perspective, browse WOLips repository on HEAD, checkout woproject/projects as "projects" 29 -1. Right-click (or equiv) on the build.xml inside of the "projects" project and Run As=>Ant Build ... 30 -1. Switch to the Classpath tab and "Add Jar" 31 -1. Browse to projects/lib and select jdom-b8.jar 32 -1. Make sure the target is the default ("dist") 62 +1. Add the wolips Git repository [[https://github.com/wolips/wolips/]] in the Git Perspective's Repository View 63 +1. Right-click (or equiv) on the ##build.xml## inside of the "woproject" project and Run As=>Ant Build ... 64 +1. Switch to the Properties tab and check for the definition of eclipse.home in the Properties list 65 +1. If ##eclipse.home## does not exist, uncheck "Use global properties" and then click "Add Property" 66 +1. In the Add Property dialog, make the name ##eclipse.home##, click Add Variable, select ##eclipse//home//##// from the list, and click OK// 67 +1. Click Apply to save your changes 33 33 1. Run 34 -1. Once it is complete, you will have to right-click=>refresh the "projects" project and you will have a temp/dist folders with the plugin site in it. 35 -1. [[Installing WOLips]] 69 +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. 36 36 37 37 == Checking out and Building inside of Eclipse for Development (PDE) == 38 38 39 -1. install jmechanic plugin from [[The JMechanic Site>>http://sourceforge.net/project/showfiles.php?group_id=68316&release_id=136699]] 40 -11. just untar this into your plugins folder 41 -1. Add the wolips CVS repository 42 -11. host = cvs.sourceforge.net 43 -11. root = /cvsroot/woproject 44 -11. protocol = pserver 45 -11. login = anonymous 46 -11. no password 47 -1. From the Java perspective, Import=>Team Project Set and select wolips.psf (see below) 48 -1. This will cause a really long checkout and you'll have a TON of build errors ... Don't fret. 49 -1. Copy ##projects/lib/cayenne-1.1RC3-dev.jar## to ##org.objectstyle.wolips.cayenne/lib/cayenne.jar## and refresh the org.objectstyle.wolips.cayenne project 50 -1. Add a classpath variable ANT//HOME that points to ##eclipse/plugins/org.apache.ant##//##1.6.5## (Preferences=>Java=>Build Path=>Classpath Variables, New... name ANT//HOME, Folder... =>youreclipsehome/plugins/org.apache.ant//1.6.5) 51 -1. make ##projects/temp##, ##projects/temp/classes##, and ##projects/temp/doc## folders 52 -1. run ##projects/build.xml## as "Ant Build ...", select the "woenvironment" and "woproject" targets and select Order... and move woenvironment above woproject in the order, Build 53 -1. copy ##projects/temp/build/woproject//$build.version/lib/woproject.jar//##// to ##org.objectstyle.wolips.woproject/lib## and refresh the org.objectstyle.wolips.woproject// 73 +1. Add the wolips Git repository [[https://github.com/wolips/wolips/]] in the Git Perspective's Repository View 74 +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]]. 54 54 55 - Youshouldendupwithnosourceor buildpatherrors.76 +== An approach to setting up the development and test environment for WOLips Plugin. == 56 56 57 - Notethat thereare16plugin.xmlandfeature.xmlsyntaxerrors.14 of them areuetoa malformedDTD fromtheEclipseTeam plugin.78 +In order to do WOLips Plugin development you will need two eclipse environments: Development and Test. 58 58 59 -=== wolips.psf === 80 +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. 81 +1. the ##temp/dist## folder is your Local Site for the Test Environment. 82 +1. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where). This will be your Test Environment. 83 +1. In the test environment, follow the [[Installing WOLips]] instructions, using your ##temp/dist## directory as the Local Site. Install the plugins. 84 +1. Use the Test environment to exercise/test the changes from your locally modified Plugin. 60 60 61 - Save thefollowing intowolips.psf:86 +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. 62 62 63 - {{codevalue="xml"}}88 +== Building WOLips with Jenkins Continuous Build server == 64 64 65 -<?xml version="1.0" encoding="UTF-8"?> 66 -<psf version="2.0"> 67 - <provider id="org.eclipse.team.cvs.core.cvsnature"> 68 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects,projects"/> 69 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/features/org.objectstyle.wolips.wounit.feature,org.objectstyle.wolips.wounit.feature"/> 70 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.wounit,org.objectstyle.wolips.wounit"/> 71 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.workbenchutilities,org.objectstyle.wolips.workbenchutilities"/> 72 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.woproject.ant,org.objectstyle.wolips.woproject.ant"/> 73 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.woproject,org.objectstyle.wolips.woproject"/> 74 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.wizards,org.objectstyle.wolips.wizards"/> 75 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.variables,org.objectstyle.wolips.variables"/> 76 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.ui,org.objectstyle.wolips.ui"/> 77 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/features/org.objectstyle.wolips.tests.feature,org.objectstyle.wolips.tests.feature"/> 78 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.tests.core,org.objectstyle.wolips.tests.core"/> 79 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.tests,org.objectstyle.wolips.tests"/> 80 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.templateengine,org.objectstyle.wolips.templateengine"/> 81 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.team,org.objectstyle.wolips.team"/> 82 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.targetbuilder,org.objectstyle.wolips.targetbuilder"/> 83 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.source,org.objectstyle.wolips.source"/> 84 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.refactoring,org.objectstyle.wolips.refactoring"/> 85 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.projectbuild,org.objectstyle.wolips.projectbuild"/> 86 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/features/org.objectstyle.wolips.profiling.feature,org.objectstyle.wolips.profiling.feature"/> 87 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.profiling,org.objectstyle.wolips.profiling"/> 88 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.preferences,org.objectstyle.wolips.preferences"/> 89 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.playground.ui,org.objectstyle.wolips.playground.ui"/> 90 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.launching,org.objectstyle.wolips.launching"/> 91 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.jdt,org.objectstyle.wolips.jdt"/> 92 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.jdom,org.objectstyle.wolips.jdom"/> 93 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.goodies.ui.mac,org.objectstyle.wolips.goodies.ui.mac"/> 94 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/features/org.objectstyle.wolips.goodies.mac.feature,org.objectstyle.wolips.goodies.mac.feature"/> 95 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.goodies.core.mac,org.objectstyle.wolips.goodies.core.mac"/> 96 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/features/org.objectstyle.wolips.feature,org.objectstyle.wolips.feature"/> 97 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.documentation,org.objectstyle.wolips.documentation"/> 98 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.doctor.ui,org.objectstyle.wolips.doctor.ui"/> 99 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.doctor.core,org.objectstyle.wolips.doctor.core"/> 100 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/features/org.objectstyle.wolips.devstudio.feature,org.objectstyle.wolips.devstudio.feature"/> 101 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.devstudio,org.objectstyle.wolips.devstudio"/> 102 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.datasets,org.objectstyle.wolips.datasets"/> 103 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.commons,org.objectstyle.wolips.commons"/> 104 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.cayenne.ant,org.objectstyle.wolips.cayenne.ant"/> 105 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.cayenne,org.objectstyle.wolips.cayenne"/> 106 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.ant,org.objectstyle.wolips.ant"/> 107 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips.wodclipse,org.objectstyle.wolips.wodclipse"/> 108 - <project reference="1.0,:pserver:cvs.sourceforge.net:/cvsroot/woproject,woproject/projects/wolips/plugins/org.objectstyle.wolips,org.objectstyle.wolips"/> 109 - </provider> 110 -</psf> 90 +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. 111 111 92 +1. Add a new job with the following configuration 93 +Project Name: WOLips 94 +Git Repositories: [[https://github.com/wolips/wolips.git]] 95 +Local module directory (optional): wolips 96 +Use update: Checked 97 +Poll SCM: 59 * ** * ** //(59 can be replaced with any number between 0 and 59)// 98 +1. Add the following build tasks to the job 99 + 100 +{{code title="Execute Shell"}} 101 + 102 +echo build.version=3.4.${SVN_REVISION} > wolips/build.properties 103 +echo eclipse.home=/usr/local/eclipse >> wolips/build.properties 104 +echo user.home=${WORKSPACE} >> wolips/build.properties 105 + 112 112 {{/code}} 107 + 108 +{{code title="Invoke Ant"}} 109 + 110 +Targets: dist 111 + 112 +{{/code}} 113 + 114 +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 115 + 116 +{{code title="Execute Shell"}} 117 + 118 +rm -fr /usr/local/www/apache22/data/wolips/* 119 +/bin/cp -prv ${WORKSPACE}/wolips/temp/dist/ /usr/local/www/apache22/data/wolips/ 120 + 121 +{{/code}} 122 + 123 +1. Copy eclipse with the necessary plugins installed to your build server. In this example it has been copied to /usr/local/eclipse 124 +The currently required plugins for a deployment build are 125 +1*. JProfiler ([[Update Site>>http://webobjects.mdimension.com/jprofiler6/]]) 126 +1*. m2Eclipse Maven ([[Update Site>>http://m2eclipse.sonatype.org/sites/m2e]]) 127 +1*. JRebel ([[Update Site>>http://www.zeroturnaround.com/update-site/]]) 128 + 129 +== Preparation for building WOLips on Windows operating systems (NT 5.0 and higher) == 130 + 131 +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. 132 + 133 +1. Install the [[BuildingWOLips-Prerequisites>>||anchor="BuildingWOLips-Prerequisites"]]. Do also follow the [[BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment>>||anchor="BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment"]] section, but don't run the build until the changes described below have been made. 134 +1. Set the VMs encoding to MacRoman 135 +1*. Right click on ##build.xml## > Properties > JRE > VM arguments 136 +1**. Dfile.encoding=MacRoman 137 +1. Edit ##woproject/wolips/goodies/plugins/build.xml## 138 +1*. Comment out the subsequent lines (mac goodies) 139 +1**. <ant dir="org.objectstyle.wolips.goodies.core.mac" target="all" /> 140 +1**. <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="all" /> 141 +1**. <ant dir="org.objectstyle.wolips.goodies.core.mac" target="dist" /> 142 +1**. <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="dist" /> 143 +1. Edit ##woproject/wolips/features/build.xml## 144 +1*. Comment out the subsequent lines (mac features) 145 +1**. <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="all" /> 146 +1**. <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="dist" /> 147 +1. Edit ##woproject/wolips/build.xml## (you may skip this one if you've got JProfiler installed) 148 +1*. Comment out the subsequent lines 149 +1**. <ant dir="jprofiler" target="all" /> 150 +1**. <ant dir="jprofiler" target="dist" /> 151 +1. Run the build 152 + 153 +== Installing from a Local Build == 154 + 155 +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 :-) 156 +1. Assuming you now have your build versions under control, you should follow the instructions for [[Building WOLips]] 157 +1. Launch Eclipse 158 +1. Select the menu: Help->Software Updates. 159 +1. Click on the 'Available Software' tab at the top of the window. 160 +1. Click on the 'Add Site...' button. This will bring up a dialog box. 161 +1. Click on the 'Local...' button on the dialog box. 162 +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. 163 +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. 164 +1. Then continue, and just keep selecting the "Yes"/"OK"/"Approve"/etc buttons