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 and Install
	1	+Getting the Wonder Source Code

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.kieran
	1	+XWiki.probert

Content

...	...	@@ -1,31 +1,115 @@
1		-== Introduction ==
	1	+{{tip title="Now with more Git"}}
	2	+As of May 21th, 2013 the Wonder source code is now maintained on [[GitHub>>url:https://github.com/||shape="rect"]] at [[https:~~/~~/github.com/wocommunity/wonder>>url:https://github.com/wocommunity/wonder||shape="rect"]]. You'll need to be familiar with the [[Git>>url:http://git-scm.com/||shape="rect"]] Source Code Management system. [[Here's>>doc: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.
	3	+{{/tip}}
2	2
3		-Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
	5	+== Why? ==
4	4
5		-* Ability to browse the source code and learn from the wisdom and experience of the WO committers
6		-* Put breakpoints in and step through Wonder source when debugging your projects
7		-* Provide opportunities to submit patches to bugs you might find in Wonder
8		-* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
	7	+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:
9	9
10		-== Downloading Wonder Source from CVS ==
	9	+* You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns
	10	+* Easily search and browse Project Wonder
	11	+* Work with a specific revision of Project Wonder, which is key for teams, quality control and development cycles
	12	+* Add logging statements to Project Wonder so you can better understand what it is doing when tracking down hard to find bugs
	13	+* Discover the Many Hidden Treasures of Wonder™.
11	11
12		-* Decide on a directory where you will maintain the latest Wonder source tree on your hard drive. I have a directory ',,/WonderLatest' in my home folder.,,
13		-* Open a terminal shell and navigate to the directory
	15	+== Download It! ==
14	14
15		-{{noformat}}
	17	+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.
16	16
17		-cd ~/WonderLatest
	19	+1. (((
	20	+===== Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like. =====
18	18
19		-{{/noformat}}
	22	+{{code 0="none"}}
	23	+git clone git://github.com/wocommunity/wonder.git WonderSource
	24	+{{/code}}
20	20
21		-* Next perform initial checkout of Wonder source tree from CVS head using the following command. This creates a folder named Wonder
	26	+If "git:~/~/" does not work for you then use "http:~/~/"
22	22
	28	+{{note title="Wonder Committers"}}
	29	+The URL above is the public, read-only URL.
	30	+ People with commit privileges for Project Wonder should use: **git@github.com:wocommunity/wonder.git**
	31	+
	32	+{{warning}}
	33	+Do **not** change "git@..." to be your username.
	34	+{{/warning}}
	35	+{{/note}}
	36	+
	37	+You should see output something like this:
	38	+
23	23	{{noformat}}
	40	+Cloning into WonderSource...
	41	+remote: Counting objects: 174269, done.
	42	+remote: Compressing objects: 100% (57304/57304), done.
	43	+remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
	44	+Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
	45	+Resolving deltas: 100% (107374/107374), done.
24	24
25		-cvs -z3 -d:pserver:anonymous@wonder.cvs.sourceforge.net:/cvsroot/wonder co -P Wonder
	47	+{{/noformat}}
	48	+)))
	49	+1. (((
	50	+===== Navigate into the working copy root =====
26	26
	52	+{{code 0="none"}}
	53	+cd WonderSource
	54	+{{/code}}
	55	+
	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:
	58	+
	59	+{{code}}
	60	+git checkout --track origin/Wonder_5_0_0_Legacy
	61	+{{/code}}
	62	+
	63	+You should get output like this:
	64	+
	65	+{{noformat}}
	66	+Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
	67	+Switched to a new branch 'Wonder_5_0_0_Legacy'
	68	+
27	27	{{/noformat}}
	70	+{{/note}}
	71	+)))
28	28
29		-== Build and Install Wonder ==
	73	+{{info}}
	74	+If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{code language="none"}}WonderSource{{/code}} directory) and start over using the same clone command above.
	75	+{{/info}}
30	30
31		-* Follow the "Building with Ant" instructions in the BUILD.txt document in the Wonder directory
	77	+== Work with the Latest Changes - Integration Branch ==
	78	+
	79	+The integration branch of Wonder is where the most recent fixes, additions, new features, etc., are merged in for testing and vetting by the community. By checking out integration you can benefit from all of these latest commits to the Wonder project before they are pulled into master/trunk. And the community can benefit by having another contributor to the improvement of Wonder. To work with the integration branch in Git, you will simply checkout that branch from your repository like so:
	80	+
	81	+{{code 0="none"}}
	82	+cd WonderSource
	83	+{{/code}}
	84	+
	85	+{{code}}
	86	+git checkout integration
	87	+{{/code}}
	88	+
	89	+== Use It! ==
	90	+
	91	+* (((
	92	+===== Use Wonder source code projects in your Eclipse workspace =====
	93	+
	94	+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: [[doc:Working with Wonder source in Eclipse]]
	95	+
	96	+{{note title="Ant Builds on your Development Machine"}}
	97	+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 locally>>doc:documentation.Installing and Configuring Jenkins]] 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** (% style="color: rgb(255,0,0);" %)**NOT**(%%) **do this for you.**
	98	+{{/note}}
	99	+)))
	100	+
	101	+* (((
	102	+===== Build and Install Project Wonder Binary Frameworks =====
	103	+
	104	+For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>doc:documentation.Building and Installing a Framework with Ant]] pages.
	105	+
	106	+{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
	107	+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.
	108	+{{/note}}
	109	+)))
	110	+
	111	+* (((
	112	+===== Build Project Wonder frameworks with Hudson/Jenkins =====
	113	+
	114	+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 [[doc:documentation.Installing and Configuring Jenkins]] page.
	115	+)))