Changes for page Getting the Wonder Source Code

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Download Wonder Source, Build, Install and Upgrade
	1	+Downloading, Building, Installing and Upgrading Wonder Source Code

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.paulh
	1	+XWiki.avendasora

Content

...	...	@@ -9,70 +9,133 @@
9	9	* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
10	10	* Discover the many Hidden Treasures of Wonder.
11	11
12		-== Source Frameworks Initial Installation ==
	12	+== Downloading ==
13	13
14		-As of March 25th, 2011, Wonder is maintained on [[GitHub>>https://github.com/]]. So [[Git>>http://git-scm.com/]] is what we use to get a local clone of the repository allowing us to directly use Wonder source.
	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 checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
	16	+{{/tip}}
15	15
16		-Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your own hard-drive.
	18	+Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your computer.
17	17
18		-{{code title="Cloning Project Wonder for the First Time"}}
	20	+1. h5. Clone the source repository from github into a new directory named "WonderSource".
19	19
20		-# Clone the source repository from github into a new directory named "WonderSource".
21		-# Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
	22	+{{note title="Read Only"}}
	23	+Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
	24	+{{/note}}
	25	+
	26	+{{code value="none"}}
22	22	git clone git://github.com/projectwonder/wonder.git WonderSource
	28	+{{/code}}
23	23
24		-# Navigate into the working copy root
	30	+You should see output something like this:
	31	+
	32	+{{noformat}}
	33	+
	34	+Cloning into WonderSource...
	35	+remote: Counting objects: 174269, done.
	36	+remote: Compressing objects: 100% (57304/57304), done.
	37	+remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
	38	+Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
	39	+Resolving deltas: 100% (107374/107374), done.
	40	+
	41	+{{/noformat}}
	42	+
	43	+1. h5. Navigate into the working copy root
	44	+
	45	+{{code value="none"}}
25	25	cd WonderSource
	47	+{{/code}}
26	26
27		-# If you are still using old WebObjects 5.3.3, then you need to execute one git command at this point
28		-# before you build Wonder to switch to the branch that is source-compatible with WO 5.3.3. See the tip at the bottom of the page.
	49	+{{note title="WebObjects 5.3.3 Compatability"}}
	50	+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}
	51	+You should get output like this:
	52	+{noformat}
	53	+Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
	54	+Switched to a new branch 'Wonder_5_0_0_Legacy'
	55	+{noformat}
29	29
30		-# Build the frameworks from the source (Assumes you are using WebObjects 5.4.3,
31		-# which is currently compatible with 'master' branch. See note below for WebObjects 5.3.3 compatible install)
	57	+{{/note}}
	58	+
	59	+== Building ==
	60	+
	61	+In general, it is recommended that you use Hudson/Jenkins to build your WebObjects applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse.
	62	+
	63	+{{tip title="Pro Tip"}}
	64	+If you use Hudson/Jenkins to build your WebObjects applications, then you do not need to actually build or install the Project Wonder frameworks on your development machine, just having the individual Wonder source code projects open in your eclipse workspace is sufficient.
	65	+{{/tip}}
	66	+
	67	+{{note title="Requires WebObjects"}}
	68	+
	69	+These build instructions require the WebObjects frameworks to already be installed in the normal location:
	70	+* Mac OS X: {{/System/Library/Framworks/}}
	71	+* Linux: {{/Library/Frameworks}}
	72	+
	73	+Otherwise you will get compiler errors like this:
	74	+{noformat}
	75	+[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
	76	+ package com.webobjects.appserver does not exist
	77	+[wocompile] import com.webobjects.appserver.WOContext;
	78	+{noformat}
	79	+
	80	+{{/note}}
	81	+
	82	+You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command:
	83	+
	84	+===== Build the frameworks from the "cloned" source. =====
	85	+
	86	+{{code value="none"}}
32	32	ant frameworks
	88	+{{/code}}
33	33
34		-# Install the frameworks (this just copies the built frameworks from ~/Roots to
35		-# the runtime Frameworks directory, usually at /Library/Frameworks)
36		-sudo ant frameworks.install
	90	+== Installing ==
37	37
	92	+Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
	93	+
	94	+===== Install the frameworks =====
	95	+
	96	+{{code value="none"}}
	97	+sudo ant frameworks.install
38	38	{{/code}}
39	39
40		-{{info value="Legacy WebObjects 5.3.3 Compatability"}}
	100	+This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
41	41
42		-If you are still stuck on WebObjects 5.3.3, for whatever reason, then you need to checkout and switch to the Wonder_5_0_0_Legacy branch *before* you build (before you run 'ant frameworks'). And this is *much* easier with git than it used to be with subversion. Just one command:
43		-
44		-{code}
45		-git checkout --track origin/Wonder_5_0_0_Legacy
46		-{code}
47		-
	102	+* Mac OS X: ##/Library/Framworks/##
	103	+* Linux: ##/Local/Library/Frameworks##
48	48
49		-{{/info}}
	105	+You can combine the build and install steps by simply executing this Ant command:
50	50
51		-== Source Frameworks Upgrade Installation ==
	107	+{{code value="none"}}
	108	+sudo ant frameworks frameworks.install
	109	+{{/code}}
52	52
53		-Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
	111	+== Upgrading ==
54	54
55		-{{code title="Updating your Source"}}
	113	+This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build.
56	56
57		-# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	115	+1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	116	+
	117	+{{code value="none"}}
58	58	cd ~/Roots/
	119	+{{/code}}
59	59
60		-# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	121	+1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	122	+
	123	+{{code value="none"}}
61	61	for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	125	+{{/code}}
62	62
63		-# Navigate to the original Wonder source directory that you created above during initial source installation
	127	+1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
	128	+
	129	+{{code value="none"}}
64	64	cd /path/to/WonderSource
	131	+{{/code}}
65	65
66		-# Pull the changes you do not have and merge them with your local repository
67		-git pull
	133	+1. h5. Pull the changes you do not have and merge them with your local repository
68	68
69		-# Clean, build and install the frameworks
70		-ant clean; ant frameworks; sudo ant frameworks.install
71		-
	135	+{{code value="none"}}
	136	+git pull
72	72	{{/code}}
73	73
74		-
75		-
76	76	{{info}}
77	77
78	78	If you have any trouble or errors due to your local repository getting hosed, then simply delete the entire local repository directory, the \~/Roots directory and just start over using the initial source clone and installation procedure outlined above.
...	...	@@ -85,15 +85,15 @@
85	85
86	86	For example:
87	87
	151	+{code:none}
	152	+cd my/special/purpose/clone/of/Wonder
	153	+ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
88	88	{code}
89		-$ cd my/special/purpose/clone/of/Wonder
90		-$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
91		-{code}
92	92
93	93	An example of where this approach might be used 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.
94	94
95	95	*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
96		-{code}
	159	+{code:none}
97	97	wo.external.root=/Users/mike/Developer/special/directory/Roots
98	98	{code}
99	99