[Lucene-hadoop Wiki] Update of "HowToRelease" by DougCutting

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-hadoop Wiki" for change notification.

The following page has been changed by DougCutting:
http://wiki.apache.org/lucene-hadoop/HowToRelease

The comment on the change is:
update for split between docs and site

------------------------------------------------------------------------------
  
  = Preparation =
  
- 	1. In trunk update news in {{{src/docs/src/documentation/content/xdocs/releases.xml}}}.  If releasing from an existing branch, merge this change to the release branch.
+ When a release will be from a new or recent branch, make the following changes in trunk and then merge them to the branch.  But when the release will be from an older branch, especially when there is already a more recent branch, make these changes directly in the branch.
+ 
+ 	1. Update the version number in {{{src/docs/src/documentation/content/xdocs/tabs.xml}}} if needed.
- 	1. From trunk regenerate the documentation.
+ 	1. Regenerate the documentation. {{{
+ ant docs
-                 {{{
- cd src/docs
- forrest
- cp -pr build/site/* ../../docs
  }}}
  	1. Update version number in {{{build.xml}}} to be ''hadoop-X.Y.N-dev'', where ''N'' is one greater than the release being made.
  	1. Update {{{CHANGES.txt}}} to include the release version and date.
- 	1. Commit these changes.
+ 	1. Commit these changes. {{{
- 		{{{
  svn commit -m "Preparing for release X.Y.Z"
  }}}
+         1. If working in trunk, merge these changes to the branch.
  
  = Branching & Merging =
  
- 	1. If this is the first release in a series (i.e. release X.Y.0), then create a branch for the series:
+ 	1. If this is the first release in a series (i.e. release X.Y.0), then create a branch for the series: {{{
-  		{{{
  svn copy https://svn.apache.org/repos/asf/lucene/hadoop/trunk \
  https://svn.apache.org/repos/asf/lucene/hadoop/branches/branch-X.Y -m "Branching for X.Y releases"
  }}}
          1. After branching the new release series, update the default version in build.xml on trunk to X.Y+1.0-dev.
- 	1. Check out the branch with: 		
+ 	1. Check out the branch with: {{{
- 		{{{
  svn co https://svn.apache.org/repos/asf/lucene/hadoop/branches/branch-X.Y
  }}}
- 	1. Merge desired patches from trunk into the branch and commit these changes. You can find the revision numbers using {{{svn log CHANGES.txt}}} in the branch and in trunk.
+ 	1. Merge desired patches from trunk into the branch and commit these changes. You can find the revision numbers using {{{svn log CHANGES.txt}}} in the branch and in trunk. {{{
-  		{{{
  cd branch-X.Y
  svn merge -rR1:R2 ../trunk .
  svn commit -m "Merge -r R1:R2 from trunk to X.Y branch. Fixes: HADOOP-A, HADOOP-B."
@@ -40, +36 @@

  
  = Building =
  
- 	1. Build the release & run unit tests.  Note that releases are normally built on 32-bit Linux, so that they include the native code for that platform.  Also, folks who build releases should install eclipse, so that the eclipse plugin can be included in releases, pre-compiled.
+ 	1. Build the release & run unit tests.  Note that releases are normally built on 32-bit Linux, so that they include the native code for that platform.  Also, folks who build releases should install eclipse, so that the eclipse plugin can be included in releases, pre-compiled. {{{
- 		 {{{
  ant -Dversion=X.Y.Z -Dcompile.native=true -Dcompile.c++=true -Declipse.home=/usr/lib/eclipse clean package-libhdfs tar test test-libhdfs
  }}}
  	1. Check that release file looks ok - e.g. install it and run examples from tutorial.
-         1. Generate the MD5 checksum of the release file.
+         1. Generate the MD5 checksum of the release file. {{{
-                 {{{
  md5sum hadoop-X.Y.Z.tar.gz > hadoop-X.Y.Z.tar.gz.md5
  }}}
- 	1. Sign the release (see [http://www.apache.org/dev/mirror-step-by-step.html?Step-By-Step Step-By-Step Guide to Mirroring Releases] for more information).
+ 	1. Sign the release (see [http://www.apache.org/dev/mirror-step-by-step.html?Step-By-Step Step-By-Step Guide to Mirroring Releases] for more information). {{{
-                 {{{
  gpg --armor --output hadoop-X.Y.Z.tar.gz.asc --detach-sig hadoop-X.Y.Z.tar.gz
  }}}
- 	1. Copy release files to a public place.
+ 	1. Copy release files to a public place. {{{
-                 {{{
  ssh people.apache.org mkdir public_html/hadoop-X.Y.Z-candidate-0
  scp -p hadoop-X.Y.Z.tar.gz* people.apache.org:public_html/hadoop-X.Y.Z-candidate-0
  }}}
@@ -62, +54 @@

  
  = Publishing =
  Once [http://www.apache.org/foundation/voting.html#ReleaseVotes three PMC members have voted for a release], it may be published.
- 	1. Tag the release:
+ 	1. Tag the release: {{{
- 		{{{
  svn copy https://svn.apache.org/repos/asf/lucene/hadoop/branches/branch-X.Y \
  https://svn.apache.org/repos/asf/lucene/hadoop/tags/release-X.Y.Z -m "Hadoop X.Y.Z release."
  }}}
- 	1. Copy release files to the distribution directory and make them writable by the lucene group.
+ 	1. Copy release files to the distribution directory and make them writable by the lucene group. {{{
-                 {{{
  ssh people.apache.org
  cp -pr public_html/hadoop-X.Y.Z-candidate-0 /www/www.apache.org/dist/lucene/hadoop/hadoop-X.Y.Z
  cd /www/www.apache.org/dist/lucene/hadoop/
  chgrp -R lucene hadoop-X.Y.Z
  chmod -R g+w hadoop-X.Y.Z
  }}}
- 	1. The release directory usually contains just two releases, the most recent from two branches, with a link named 'stable' to the most recent recommended version.
+ 	1. The release directory usually contains just two releases, the most recent from two branches, with a link named 'stable' to the most recent recommended version. {{{
-                 {{{
  ssh people.apache.org
  cd /www/www.apache.org/dist/lucene/hadoop/
  rm -rf hadoop-A.B.C; rm stable
  ln -s hadoop-A.B.D stable
  }}}
  	1. Wait 24 hours for release to propagate to mirrors.
- 	1. Deploy new Hadoop site.
-                 {{{
+         1. Prepare to edit the website. {{{
+ svn co https://svn.apache.org/repos/asf/lucene/hadoop/site
+ }}}
+         1. Add the newly tagged release to the website as an external.  If releasing from an existing branch, replace the old tagged version with the new version.  If adding a new branch, remove the oldest branch and add the new one. {{{
+ svn propedit svn:externals publish
+ }}}
+ 	1. Update the documentation links in {{{author/src/documentation/content/xdocs/site.xml}}}.
+ 	1. Regenerate the site, review it, then commit it. {{{
+ ant
+ firefox publish/index.html
+ svn commit -m "Updated site for release X.Y.Z."
+ }}}
+ 	1. Deploy your site changes. {{{
  ssh people.apache.org
  cd /www/lucene.apache.org/hadoop
  svn up
  }}}
- 	1. Update Javadoc in {{{people.apache.org:/www/lucene.apache.org/hadoop/api}}}, by doing the following in your home directory
+ 	1. Copy the new Javadoc to {{{people.apache.org:/www/lucene.apache.org/hadoop/docs/rX.Y.Z/api}}}, by doing the following in your home directory on people.apache.org: {{{
-                 {{{
  ssh people.apache.org
- tar xvf /www/www.apache.org/dist/lucene/hadoop/hadoop-X.Y.Z/hadoop-X.Y.Z.tar.gz */docs/api
+ tar xvf /www/www.apache.org/dist/lucene/hadoop/hadoop-X.Y.Z/hadoop-X.Y.Z.tar.gz '*/docs/api'
  chmod -R 775 hadoop-X.Y.Z
  chgrp -R lucene hadoop-X.Y.Z
- rm -r /www/lucene.apache.org/hadoop/api/
- cp -r hadoop-X.Y.Z/docs/ /www/lucene.apache.org/hadoop/
+ cp -r hadoop-X.Y.Z/docs/api /www/lucene.apache.org/hadoop/docs/rX.Y.Z
  rm -r hadoop-X.Y.Z
  }}}
  	1. Send announcements to the user and developer lists.