This page is prepared for Apache Avro committers. You need committer rights to create a new Apache Avro release.
Branching
Skip this section if this is NOT the first release in a series (i.e. release X.Y.0).
- Update
CHANGES.txt
to include the release version and date (useUnreleased
for the date if it is unknown) and removeTrunk (unreleased changes)
. - Commit these changes to trunk.
svn commit -m "Preparing for release X.Y.Z"
- Create a branch for the release series:
svn copy https://svn.apache.org/repos/asf/avro/trunk \ https://svn.apache.org/repos/asf/avro/branches/branch-X.Y -m "Branching for X.Y releases"
- Update
CHANGES.txt
to add back inTrunk (unreleased changes)
. - Update the default version in
share/VERSION.txt
on trunk to X.Y+1.0-SNAPSHOT. Be sure not to leave a trailing newline. - 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.
- Check out the branch with:
svn co https://svn.apache.org/repos/asf/avro/branches/branch-X.Y
- 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). - Update the version number in
share/VERSION.txt
to be ''avro-X.Y.Z-SNAPSHOT''. Be sure not to leave a trailing newline. - Commit these changes.
svn commit -m "Preparing for release X.Y.Z"
- Add the fix version X.Y.Z to the Avro JIRA
- 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."
- For each patch merged, change the fix version for the JIRA issue to be X.Y.Z
- Go through CHANGES.txt, JIRA, and svn log to be sure that the issues included in the branch match in each location, then update the date in CHANGES.txt to be today.
- Update the version number in
share/VERSION.txt
to be ''avro-X.Y.Z''. Be sure not to leave a trailing newline. - Tag the release candidate (R is the release candidate number):
svn copy https://svn.apache.org/repos/asf/avro/branches/branch-X.Y \ https://svn.apache.org/repos/asf/avro/tags/release-X.Y.Z-rcR -m "Avro X.Y.Z-rcR release."
Building
- Build the release & run unit tests.
./build.sh clean dist test
- Check that release files look ok - e.g. unpack the sources and run tests.
- Sign the release (see Step-By-Step Guide to Mirroring Releases for more information). To sign a release, your key be present in the dist/KEYS file. See the Apache guide to Signing Releases for more details.
./build.sh sign
- Copy release files to a public place.
ssh people.apache.org mkdir public_html/avro-X.Y.Z-RC0 scp -pr dist/* people.apache.org:public_html/avro-X.Y.Z-RC0
- Call a release vote on avro-dev at hadoop.apache.org.
Publishing
Once three PMC members have voted for a release, it may be published.
- Tag the release:
svn move https://svn.apache.org/repos/asf/avro/tags/release-X.Y.Z-rcR \ https://svn.apache.org/repos/asf/avro/tags/release-X.Y.Z -m "Avro X.Y.Z release."
- 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/avro/avro-X.Y.Z cd /www/www.apache.org/dist/avro chgrp -R hadoop avro-X.Y.Z chmod -R g+w avro-X.Y.Z
- 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/avro rm -rf avro-A.B.C; rm stable ln -s hadoop-A.B.D stable
- Publish Java artifacts to the Maven repository:
ssh people.apache.org mkdir /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/avro/X.Y.Z cd /www/www.apache.org/dist/avro/avro-X.Y.Z/java cp -p avro-X.Y.Z{,-javadoc,-sources}.* /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/avro/X.Y.Z
- Publish Python artifacts to PyPI (need to have setuptools installed)
cd lang/py python setup.py build sdist upload
- Publish Ruby artifacts to RubyGems
- Wait 24 hours for release to propagate to mirrors.
- Prepare to edit the website.
svn co https://svn.apache.org/repos/asf/avro/site
- Update the documentation links in
author/content/xdocs/site.xml
. - Update the release news in
author/content/xdocs/releases.xml
. - 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."
- Deploy your site changes.
ssh people.apache.org cd /www/hadoop.apache.org/avro svn up
- Copy the new release docs to
people.apache.org:/www/hadoop.apache.org/avro/docs/rX.Y.Z
and update thedocs/current
link, by doing the following in your home directory on people.apache.org:ssh people.apache.org tar xzf /www/www.apache.org/dist/avro/avro-X.Y.Z/avro-doc-X.Y.Z.tar.gz chmod -R 775 avro-doc-X.Y.Z chgrp -R hadoop avro-doc-X.Y.Z cp -rp avro-doc-X.Y.Z /www/hadoop.apache.org/avro/docs/X.Y.Z rm -r avro-doc-X.Y.Z cd /www/hadoop.apache.org/avro/docs/ ln -s X.Y.Z current
- Send announcements to the user and developer lists once the site changes are visible.
- Update the version number in
share/VERSION.txt
to be ''avro-X.Y.N-SNAPSHOT'', where ''N'' is one greater than the release just made. - In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
- 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.
- In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.
Using AWS for Avro Build and Release
I've chosen the instance ID of ami-2d4aa444, which is the 32-bit Lucid Lynx with instance storage in us-east-1 (see http://uec-images.ubuntu.com/releases/lucid/release for other options in the Lucid Lynx family). Be sure to open port 80 in the security group under which you start the instance, as Javadoc needs to fetch remote documentation. Once you've started and ssh'ed into the instance, execute the below bash commands. Note also that you'll need to navigate Sun/Oracle's sweet user interface for installation. I've found it easiest to use tab to move to the "OK" box and space to select "OK".
# If you want to check out code and edit it with emacs sudo apt-get install emacs23-lucid subversion # C dependencies sudo apt-get install gcc automake libtool asciidoc # C++ dependencies sudo apt-get install g++ libboost-all-dev source-highlight flex bison doxygen # Ruby dependencies sudo apt-get install ruby ruby-dev rake rubygems libopenssl-ruby sudo gem install echoe sudo gem install yajl-ruby # Python dependencies sudo apt-get install python-pip sudo pip install setuptools # Java dependencies sudo add-apt-repository "deb http://archive.canonical.com/ lucid partner" sudo apt-get update sudo apt-get install ant sun-java6-jdk
To build the documentation for the distribution, you need to have Java 5 for use with Apache Forrest (really the worst thing ever). Instructions for the installation are at http://java.sun.com/j2se/1.5.0/install-linux.html, and the binary installation file is available for download at http://java.sun.com/javase/downloads/5u22/jdk. You'll also need to download Forrest, currently available as a tarball at http://apache.siamwebhosting.com/forrest/apache-forrest-0.8.tar.gz. Lastly, you'll want to update your ~/build.properties
file to tell Ant where to find Java 5 and Forrest; for example:
java5.home=/home/ubuntu/jdk1.5.0_22 forrest.home=/home/ubuntu/apache-forrest-0.8
The Java test-tools target seems to require the JAVA_HOME environment variable to be set as well. I'm not sure that this is necessary; see AVRO-566.