Changes for page Getting the Wonder Source Code

Summary

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

Details

Page properties

Content

...	...	@@ -1,5 +3,3 @@
1		-{{toc maxLevel="2"}}{{/toc}}
2		-
3	3	== Introduction ==
4	4
5	5	Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
...	...	@@ -14,136 +14,86 @@
14	14	== Downloading ==
15	15
16	16	{{tip title="Now with more Git"}}
17		-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.
	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.
18	18	{{/tip}}
19	19
20	20	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.
21	21
22		-1. h5. Clone the source repository from github into a new directory named "WonderSource".
	20	+1. Clone the source repository from github into a new directory named "WonderSource".
23	23
24	24	{{note title="Read Only"}}
25	25	Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
26	26	{{/note}}
27	27
28		-{{code value="none"}}
	26	+{{code}}
29	29	git clone git://github.com/projectwonder/wonder.git WonderSource
30	30	{{/code}}
31	31
32		-You should see output something like this:
	30	+1. Navigate into the working copy root
33	33
34		-{{noformat}}
35		-
36		-Cloning into WonderSource...
37		-remote: Counting objects: 174269, done.
38		-remote: Compressing objects: 100% (57304/57304), done.
39		-remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
40		-Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
41		-Resolving deltas: 100% (107374/107374), done.
42		-
43		-{{/noformat}}
44		-
45		-1. h5. Navigate into the working copy root
46		-
47		-{{code value="none"}}
	32	+{{code}}
48	48	cd WonderSource
49	49	{{/code}}
50	50
51	51	{{note title="WebObjects 5.3.3 Compatability"}}
52		-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}
53		-You should get output like this:
54		-{noformat}
55		-Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
56		-Switched to a new branch 'Wonder_5_0_0_Legacy'
57		-{noformat}
	37	+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	58
59	59	{{/note}}
60	60
61	61	== Building ==
62	62
63		-In general, it is recommended that you use Hudson/Jenkins to build your WebObjects frameworks and applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse directly.
	43	+Assuming you now have a "cloned" copy of the Wonder source code, you can build the frameworks to the default (##/Roots##) with the following command:
64	64
65		-{{tip title="Pro Tip"}}
66		-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. Your Hudson/Jenkins server will need the built frameworks installed. See the [Hudson/Jenkins Page|WO:Installing and Using the Hudson build server] for more information.
67		-{{/tip}}
	45	+1. Build the frameworks from the "cloned" source.
68	68
69		-{{note title="Requires WebObjects"}}
70		-
71		-These build instructions require the WebObjects frameworks to already be installed in the normal location:
72		-* Mac OS X: {{/System/Library/Framworks/}}
73		-* Linux: {{/Library/Frameworks}}
74		-
75		-Otherwise you will get compiler errors like this:
76		-{noformat}
77		-[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
78		- package com.webobjects.appserver does not exist
79		-[wocompile] import com.webobjects.appserver.WOContext;
80		-{noformat}
81		-
82		-{{/note}}
83		-
84		-You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command:
85		-
86		-===== Build the frameworks from the "cloned" source. =====
87		-
88		-{{code value="none"}}
	47	+{{code}}
89	89	ant frameworks
90	90	{{/code}}
91	91
92		-== Installing ==
	51	+1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
93	93
94		-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.
95		-
96		-===== Install the frameworks =====
97		-
98		-{{code value="none"}}
	53	+{{code}}
99	99	sudo ant frameworks.install
100	100	{{/code}}
101	101
102		-This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
	57	+== Installing and Upgrading ==
103	103
104		-* Mac OS X: ##/Library/Framworks/##
105		-* Linux: ##/Local/Library/Frameworks##
	59	+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.
106	106
107		-You can combine the build and install steps by simply executing this Ant command:
	61	+1. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
108	108
109		-{{code value="none"}}
110		-sudo ant frameworks frameworks.install
	63	+{{code}}
	64	+cd ~/Roots/
111	111	{{/code}}
112	112
113		-== Upgrading ==
	67	+1. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
114	114
115		-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.
	69	+{{code}}
	70	+for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	71	+{{/code}}
116	116
117		-1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
	73	+1. Navigate to the original Wonder source directory that you created above during initial source installation
118	118
119		-{{code value="none"}}
	75	+{{code}}
120	120	cd /path/to/WonderSource
121	121	{{/code}}
122	122
123		-1. h5. Pull the changes you do not have and merge them with your local repository
	79	+1. Pull the changes you do not have and merge them with your local repository
124	124
125		-{{code value="none"}}
	81	+{{code}}
126	126	git pull
127	127	{{/code}}
128	128
129		-1. h5. Build the frameworks.
	85	+1. Clean, build and install the frameworks
130	130
131		-{{code value="none"}}
	87	+{{code}}
	88	+
	89	+ant clean
132	132	ant frameworks
133		-{{/code}}
	91	+sudo ant frameworks.install
134	134
135		-1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
136		-
137		-{{code value="none"}}
138		-cd ~/Roots/
139	139	{{/code}}
140	140
141		-1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
142		-
143		-{{code value="none"}}
144		-for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
145		-{{/code}}
146		-
147	147	{{info}}
148	148
149	149	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.
...	...	@@ -156,15 +156,15 @@
156	156
157	157	For example:
158	158
159		-{code:none}
160		-cd my/special/purpose/clone/of/Wonder
161		-ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
162	162	{code}
	108	+$ cd my/special/purpose/clone/of/Wonder
	109	+$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
	110	+{code}
163	163
164	164	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.
165	165
166	166	*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
167		-{code:none}
	115	+{code}
168	168	wo.external.root=/Users/mike/Developer/special/directory/Roots
169	169	{code}
170	170