Changes for page Getting the Wonder Source Code
Last modified by Bastian Triller on 2013/10/05 10:40
From version 112.1
edited by David Avendasora
on 2011/04/25 10:24
on 2011/04/25 10:24
Change comment:
There is no comment for this version
To version 110.1
edited by David Avendasora
on 2011/06/16 18:24
on 2011/06/16 18:24
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - DownloadWonder Source,Build, Install and Upgrade1 +Getting the Wonder Source Code - Content
-
... ... @@ -1,101 +1,93 @@ 1 - ==Introduction==1 +{{tip title="Now with more Git"}} 2 2 3 - Instead ofdownloading theWonder binaries,workingfromthelatest source codedirectly can have someadvantagessuch as:3 +As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. You'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. [Here's|WO:Getting Started with Git] a good place to start. You will use Git to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source. 4 4 5 -* Learn a lot about WebObjects and EOF (and Java development styles) 6 -* Easily browse and search the source 7 -* Work with a specific source control version (teams, quality control, development cycles) 8 -* Provide opportunities to submit patches for bug fixes or enhancements 9 -* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs 10 -* Discover the many Hidden Treasures of Wonder. 11 - 12 -== Source Frameworks Initial Installation == 13 - 14 -{{tip title="Now with more Git"}} 15 -As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. So you'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. You will use it to get a local copy of the repository (a "clone" in Git terms) allowing us to have direct access to the Wonder source. 16 16 {{/tip}} 17 17 18 - Opena terminal and navigate to a directory whereyouwant to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your own hard-drive.7 +== Why? == 19 19 20 -1. Clone the source repository from github into a new directory named "WonderSource". 21 -1. Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write 9 +Instead of constantly re-downloading and installing the latest Project Wonder binaries you should work directly with the latest source code. It has several advantages including: 22 22 23 -{{code}} 24 -git clone git://github.com/projectwonder/wonder.git WonderSource 25 -{{/code}} 11 +* You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns 12 +* Easily search and browse Project Wonder 13 +* Work with a specific revision of Project Wonder, which is key for teams, quality control and development cycles 14 +* Add logging statements to Project Wonder so you can better understand what it is doing when tracking down hard to find bugs 15 +* Discover the Many Hidden Treasures of Wonder™. 26 26 27 - 1.Navigate intotheworking copyroot17 +== Download It == 28 28 29 -{{code}} 30 -cd WonderSource 31 -{{/code}} 19 +Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following commands to clone Wonder source to your computer. 32 32 33 -{{note title="WebObjects 5.3.3 Compatability"}} 34 -If you are still using old WebObjects 5.3.3, then you need to execute this git command to switch to the branch for WebObjects 5.3.3:{code}git checkout --track origin/Wonder_5_0_0_Legacy{code} 21 +1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like. 35 35 36 -{{/note}} 37 - 38 -1. Build the frameworks from the source. 39 - 40 -{{code}} 41 -ant frameworks 23 +{{code value="none"}} 24 +git clone git://github.com/projectwonder/wonder.git WonderSource 42 42 {{/code}} 43 43 44 - 1.Install theframeworks(this justcopies thebuilt frameworksfrom/Rootsto theruntimeFrameworksdirectory,usually atLibrary/Frameworks)27 +If "git:~/~/" does not work for you then use "http:~/~/" 45 45 46 -{{code}} 47 -sudo ant frameworks.install 48 -{{/code}} 29 +{{note title="Wonder Committers"}} 49 49 50 -œ 31 +The URL above is the public, read-only URL. 32 +People with commit privileges for Project Wonder should use: *{{git@github.com:projectwonder/wonder.git}}* 33 +{warning}Do *not* change "git@..." to be your username.{warning} 51 51 52 - == Source Frameworks Upgrade Installation ==35 +{{/note}} 53 53 54 - Assumingyoualreadycloned and installed Wonderfrom source usingthe method outlinedabove, you can usethe followingprocedure pull thelatest changesinto your local repository.37 +You should see output something like this: 55 55 56 -{{ code title="Updating your Source"}}39 +{{noformat}} 57 57 58 -# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above 59 -cd ~/Roots/ 41 +Cloning into WonderSource... 42 +remote: Counting objects: 174269, done. 43 +remote: Compressing objects: 100% (57304/57304), done. 44 +remote: Total 174269 (delta 107374), reused 173934 (delta 107067) 45 +Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done. 46 +Resolving deltas: 100% (107374/107374), done. 60 60 61 -# Delete all installed frameworks whose names match the built frameworks in this Roots build folder 62 -for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done 48 +{{/noformat}} 63 63 64 -# Navigate to the original Wonder source directory that you created above during initial source installation 65 -cd /path/to/WonderSource 50 +1. h5. Navigate into the working copy root 66 66 67 -# Pull the changes you do not have and merge them with your local repository 68 -git pull 52 +{{code value="none"}} 53 +cd WonderSource 54 +{{/code}} 69 69 70 -# Clean, build and install the frameworks 71 -ant clean; ant frameworks; sudo ant frameworks.install 56 +{{note title="WebObjects 5.3.3 Compatability"}} 57 +If you are still using old WebObjects 5.3.3, then you need to execute this git command to switch to the branch for WebObjects 5.3.3: {code}git checkout --track origin/Wonder_5_0_0_Legacy{code} 58 +You should get output like this: 59 +{noformat} 60 +Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin. 61 +Switched to a new branch 'Wonder_5_0_0_Legacy' 62 +{noformat} 72 72 73 -{{/ code}}64 +{{/note}} 74 74 75 75 {{info}} 76 76 77 -If you have any trouble or errors due to your local repository getting hosed,thensimply delete the entire local repositorydirectory, the \~/Roots directory andjuststart over using theinitialsource cloneand installation procedureoutlined above.68 +If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{\~/Roots}} directory) and start over using the same clone command above. 78 78 79 79 {{/info}} 80 80 81 - {{info value="CustomDevelopmentEnviromentFile layout using Custom wolips.properties"}}72 +== Use It == 82 82 83 -If you have a custom wolips properties file for a specific workspace and you want to have a specific Wonder clone for that workspace, you can simply link your custom wolips properties file to a soft link named build.properties in the working copy root directory. The Wonder build script will supersede all other filesystem layout poperties with the properties in that file. 74 +* h5. Use Wonder source code projects in your Eclipse workspace 75 +The best way to make use of Project Wonder is obviously to import the source code projects directly into your Eclipse workspace. Why would you be reading this page if that isn't what you are trying to do? Detailed instructions are here: [[WONDER:Working with Wonder source in Eclipse]] 84 84 85 - For example:77 +{{note title="Ant Builds on your Development Machine"}} 86 86 87 -{code} 88 -$ cd my/special/purpose/clone/of/Wonder 89 -$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties 90 -{code} 79 +WOlips' "Incremental Builder" is an incredibly helpful feature during development, but it does things that the Ant deployment build does not do. If you are *either* using WOLips to build your WebObjects Applications (_WOLips Ant Tools > Install_) *or* are [running Hudson/Jenkins|WO:Installing and Using the Hudson build server] locally to do it, you *must* also build and install your workspace's Frameworks that your Application depends upon -- including your own, Project Wonder's and any others. *The standard Ant build does* {color:#ff0000}{*}NOT{*}{color} *do this for you.* 91 91 92 - Anexampleof wherethis approach might beused would be when you have different projects (perhaps in a specially designated workspace) that use a specific version of WebObjects and a specific version or branch of Wonder.81 +{{/note}} 93 93 94 -*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example 95 -{code} 96 -wo.external.root=/Users/mike/Developer/special/directory/Roots 97 -{code} 83 +* h5. Build and Install Project Wonder Binary Frameworks 84 +For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>WO:Building and Installing a WO Framework with Ant]] pages. 98 98 99 - *Tip:* A custom WebServerinstall directory can bespecifiedtoWonderby addingthe property'wo.server.root'tothe customwolips propertiesfilealso.86 +{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}} 100 100 101 -{{/info}} 88 +If you have both Source Code projects and the built, Binary Frameworks installed, you need to make sure you build all source code frameworks that your project depends upon first. _The standard Ant build does not do this for you._ Ant builds only use binary frameworks so if the installed frameworks are not up to date your Ant build could fail, or worse, succeed but contain run-time errors. 89 + 90 +{{/note}} 91 + 92 +* h5. Build Project Wonder frameworks with Hudson/Jenkins 93 +The ideal way to build WebObjects frameworks and applications is to use a "Continuous Integration Server" or "Build Server" like Hudson or Jenkins. This allows you to automate the often complex process of building WebObjects projects that have several dependencies on frameworks. Instructions on how to setup a Hudson/Jenkins server is are available on the [[WO:Installing and Using Jenkins and Hudson Build Servers]] page.