[Hadoop Wiki] Update of "Avro/HowToRelease" by DougCutting

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

Dear Wiki user,

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

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

New page:
''This page is prepared for Hadoop Avro committers. You need committer rights 
to create a new  Hadoop Avro release.''


= Branching =

Skip this section if this is NOT the first release in a series (i.e. release X.Y.0).

	1. Update {{{CHANGES.txt}}} to include the release version and date (use {{{Unreleased}}} for the date if it is unknown) and remove {{{Trunk (unreleased changes)}}}.
	1. Commit these changes to trunk. {{{
svn commit -m "Preparing for release X.Y.Z"
}}}
	1. Create a branch for the release series: {{{
svn copy https://svn.apache.org/repos/asf/hadoop/avro/trunk \
https://svn.apache.org/repos/asf/hadoop/avro/branches/branch-X.Y -m "Branching for X.Y releases"
}}}
	1. Update {{{CHANGES.txt}}} to add back in {{{Trunk (unreleased changes)}}}.
        1. Update the default version in {{{build.xml}}} on trunk to X.Y+1.0-dev.
	1. Update the version number in {{{src/docs/content/xdocs/tabs.xml}}} on trunk to X.Y+1.0.
	1. Commit these changes to trunk. {{{
svn commit -m "Preparing for X.Y+1.0 development"
}}}

= Updating Release Branch =

These operations take place in the release branch.

	1. Check out the branch with: {{{
svn co https://svn.apache.org/repos/asf/hadoop/avro/branches/branch-X.Y
}}}
	1. Update {{{CHANGES.txt}}} to include the release version and date (this change must be committed to trunk and any intermediate branches between trunk and the branch being released).
	1. Update {{{src/docs/releasenotes.html}}} with release notes for this release.
	1. Update the version number in {{{build.xml}}} to be ''avro-X.Y.N-dev'', where ''N'' is one greater than the release being made.
	1. Commit these changes. {{{
svn commit -m "Preparing for release X.Y.Z"
}}}
	1. If not already done, 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: AVRO-A, AVRO-B."
}}}
	1. Tag the release candidate (R is the release candidate number): {{{
svn copy https://svn.apache.org/repos/asf/hadoop/avro/branches/branch-X.Y \
https://svn.apache.org/repos/asf/hadoop/avro/tags/release-X.Y.Z-rcR -m "Avro X.Y.Z-rcR release."
}}}

= Building =

	1. Build the release & run unit tests.  {{{
ant -Dversion=X.Y.Z clean tar test
}}}
	1. Check that release file looks ok - e.g. install it and run examples from tutorial.
	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 avro-X.Y.Z.tar.gz.asc --detach-sig avro-X.Y.Z.tar.gz
}}}
	1. Copy release files to a public place. {{{
ssh people.apache.org mkdir public_html/avro-X.Y.Z-candidate-0
scp -p avro-X.Y.Z.tar.gz* people.apache.org:public_html/avro-X.Y.Z-candidate-0
}}}
        1. Call a release vote on avro-dev at hadoop.apache.org.

= 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: {{{
svn move https://svn.apache.org/repos/asf/hadoop/avro/tags/release-X.Y.Z-rcR \
https://svn.apache.org/repos/asf/hadoop/avro/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 hadoop group. {{{
ssh people.apache.org
cp -pr public_html/avro-X.Y.Z-candidate-0 /www/www.apache.org/dist/hadoop/avro/hadoop-X.Y.Z
cd /www/www.apache.org/dist/hadoop/avro
chgrp -R hadoop avro-X.Y.Z
chmod -R g+w avro-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. {{{
ssh people.apache.org
cd /www/www.apache.org/dist/hadoop/avro
rm -rf avro-A.B.C; rm stable
ln -s hadoop-A.B.D stable
}}}
	1. Wait 24 hours for release to propagate to mirrors.
        1. Prepare to edit the website. {{{
svn co https://svn.apache.org/repos/asf/hadoop/avro/site
}}}
	1. Update the documentation links in {{{author/content/xdocs/site.xml}}}.
	1. Update the release news in {{{author/content/xdocs/releases.xml}}}.
	1. Regenerate the site, review it, then commit it. {{{
ant -Dforrest.home=/usr/local/forrest -Djava5.home=/usr/local/jdk1.5
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/hadoop.apache.org/avro
svn up
}}}
	1. Copy the new release docs to {{{people.apache.org:/www/hadoop.apache.org/avro/docs/rX.Y.Z}}} and update the {{{docs/current}}} link, by doing the following in your home directory on people.apache.org: {{{
ssh people.apache.org
tar xvf /www/www.apache.org/dist/hadoop/avro/avro-X.Y.Z/avro-X.Y.Z.tar.gz '*/docs'
chmod -R 775 avro-X.Y.Z
chgrp -R hadoop avro-X.Y.Z
cp -rp avro-X.Y.Z/docs /www/hadoop.apache.org/avro/docs/rX.Y.Z
rm -r avro-X.Y.Z
cd /www/hadoop.apache.org/avro/docs/
ln -s rX.Y.Z current
}}}
	1. Send announcements to the user and developer lists once the site changes are visible.
        1. In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
        1. In Jira, "release" the version.  Visit the "Administer Project" page, then the "Manage versions" page.   You need to have the "Admin" role in Avro's Jira for this step and the next.
        1. In Jira, close issues resolved in the release.  Disable mail notifications for this bulk change.

= See Also =

 * [http://www.apache.org/dev/release.html Apache Releases FAQ]