[Bast-commits] r9867 - ironman/IronMan-Web/trunk

[idn at dev.catalyst.perl.org]

Author: idn
Date: 2011-04-10 09:46:01 +0000 (Sun, 10 Apr 2011)
New Revision: 9867

Modified:
   ironman/IronMan-Web/trunk/development-cycle.pod
Log:
Fixing borked dev docs

Modified: ironman/IronMan-Web/trunk/development-cycle.pod
===================================================================
--- ironman/IronMan-Web/trunk/development-cycle.pod	2011-04-10 09:30:36 UTC (rev 9866)
+++ ironman/IronMan-Web/trunk/development-cycle.pod	2011-04-10 09:46:01 UTC (rev 9867)
@@ -8,14 +8,34 @@
  
 The latest version of this document can be found at:
 
-    http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/branches/dev/development-cycle.pod
+    http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/trunk/development-cycle.pod
 
-=head2 Development branch preparation.
+The repository is layed out as follows:
 
-The development branch has the following known intentional differences:
+    branches    - current development branches
+    tags        - current releases including live and dev sites
+    trunk       - current cutting edge waiting for release tagging
 
-=head3 The '-Debug' option
+=head1 Trunk and branches.
 
+Trunk contains the latest cutting edge code.  It's recommended that you don't
+work directly in trunk, but create yourself a branch.
+
+=head2 Branches.
+
+Create your own branch for 'very cool new feature' as follows:
+
+    svn cp http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/trunk/ \
+           http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/branches/very_cool_new_feature \
+        -m "Creating branch to work on my very cool new feature"
+
+Work on files in your branch, then once you're done you can either poke someone
+on the irc channel or you can merge it back into trunk yourself (see below).
+
+=head2 The '-Debug' option
+
+You may wish to enable the Catalyst debugging module within your branch.
+
     diff -Naur branches/ironboy/lib/IronMan/Web.pm branches/dev/lib/IronMan/Web.pm
     --- branches/ironboy/lib/IronMan/Web.pm 2010-07-10 10:37:30.825413356 +0100
     +++ branches/dev/lib/IronMan/Web.pm     2010-07-10 10:37:31.174421647 +0100
@@ -28,22 +48,65 @@
      
      our $VERSION = '0.01';
 
-=head2 Comparing branches
 
-Use the following to compare the two branches:
+=head1 Merging bug fixes and branches back into trunk.
 
-    diff -Naur branches/ironboy/ branches/dev/ --exclude .svn | more
+In order to maintain a nice history and clean revisions for rollback and
+additions, we'll create ourselves a new tagged version and then copy that
+to ironboy for testing.  Once testing is completed, we'll delete the
+ironboy tag and copy ironman to it.
 
-Carefully review the changes presented to ensure there is nothing unexpected.
+=head2 Merging into trunk
 
-=head2 Development to IronBoy
+Merging a branch back into trunk:
 
-Merge the changes from dev to ironboy, I suggest doing this per file (eg :
+    svn co http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/trunk/
+    cd trunk
+    svn merge --reintegrate http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/branches/very_cool_new_feature
+    svn commit -m "Merging very cool new feature branch back into trunk"
 
+=head2 Comparing branches for cherry picking
 
 
-    svn merge 
+Need to add docs here...
 
-    
 
+=head1 Release process
+
+=head2 Trunk to release
+
+Increment the version number within lib/IronMan/Web.pm:
+
+    our $VERSION = '0.02';
+
+Commit the change:
+
+    svn commit lib/IronMan/Web.pm -m "Incrementing version"
+
+Copy trunk to the release:
+
+    svn cp http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/IronMan-Web-0.02 \
+           http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/ironboy \
+        -m "Releasing IronMan-Web-0.02 to ironboy"
+
+=head2 Release to ironboy
+
+Delete the currently tagges ironman
+
+    svn del http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/ironboy \
+         -m "Removing ironboy for release of IronMan-Web-0.02"
+    svn cp http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/IronMan-Web-0.02 \
+           http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/ironboy \
+        -m "Releasing IronMan-Web-0.02 to ironboy"
+
+=head2 Ironboy to ironman
+
+Delete the currently tagges ironman
+
+    svn del http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/ironman \
+         -m "Removing ironman for release of ironboy"
+    svn cp http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/ironboy
+           http://dev.catalyst.perl.org/repos/bast/ironman/IronMan-Web/tags/ironman \
+        -m "Releasing ironboy to ironman"
+
 =cut