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


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).

  2. Commit these changes to trunk.

    svn commit -m "Preparing for release X.Y.Z"
  3. Create a branch for the release series:

    svn copy \ -m "Branching for X.Y releases"
  4. Update CHANGES.txt to add back in Trunk (unreleased changes).

  5. Update the default version in share/VERSION.txt on trunk to X.Y+1.0-SNAPSHOT.

  6. 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
  2. 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).

  3. Update the version number in share/VERSION.txt to be avro-X.Y.Z.

  4. Commit these changes.

    svn commit -m "Preparing for release X.Y.Z"
  5. Add the fix version X.Y.Z to the Avro JIRA
  6. 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."
  7. For each patch merged, change the fix version for the JIRA issue to be X.Y.Z
  8. Tag the release candidate (R is the release candidate number):

    svn copy \ -m "Avro X.Y.Z-rcR release."


  1. Build the release & run unit tests.

    ./ clean dist test
  2. Check that release files look ok - e.g. unpack the sources and run tests.
  3. Sign the release (see Step-By-Step Guide to Mirroring Releases for more information).

    ./ sign
  4. Copy release files to a public place.

    ssh mkdir public_html/avro-X.Y.Z-RC0
    scp -pr dist/*
  5. Call a release vote on avro-dev at


Once three PMC members have voted for a release, it may be published.

  1. Tag the release:

    svn move \ -m "Avro X.Y.Z release."
  2. Copy release files to the distribution directory and make them writable by the hadoop group.

    cp -pr public_html/avro-X.Y.Z-candidate-0 /www/
    cd /www/
    chgrp -R hadoop avro-X.Y.Z
    chmod -R g+w avro-X.Y.Z
  3. 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.

    cd /www/
    rm -rf avro-A.B.C; rm stable
    ln -s hadoop-A.B.D stable
  4. Publish Java artifacts to the Maven repository:

    mkdir /www/
    cd /www/
    cp -p avro-X.Y.Z{,-javadoc,-sources}.* /www/
  5. Wait 24 hours for release to propagate to mirrors.
  6. Prepare to edit the website.

    svn co
  7. Update the documentation links in author/content/xdocs/site.xml.

  8. Update the release news in author/content/xdocs/releases.xml.

  9. 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."
  10. Deploy your site changes.

    cd /www/
    svn up
  11. Copy the new release docs to and update the docs/current link, by doing the following in your home directory on

    tar xzf /www/
    chmod -R 775 avro-doc-X.Y.Z
    chgrp -R hadoop avro-doc-X.Y.Z
    cp -rp avro-doc-X.Y.Z /www/
    rm -r avro-doc-X.Y.Z
    cd /www/
    ln -s X.Y.Z current
  12. Send announcements to the user and developer lists once the site changes are visible.
  13. 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.

  14. In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
  15. 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.
  16. In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.

See Also

Avro/HowToRelease (last edited 2010-06-01 16:56:53 by n218103111130)