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

Preparation

  1. Bulk update Jira to unassign from this release all issues that are open non-blockers and send follow-up notification to the developer list that this was done.

Branching

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

  1. Notify developers on the #hadoop IRC channel that you are about to branch a release.
  2. Update CHANGES.txt to include the release version and date (use Unreleased for the date if it is unknown) and remove Trunk (unreleased changes).

  3. Regenerate the documentation.

    ant docs
  4. Commit these changes to trunk.

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

    svn copy https://svn.apache.org/repos/asf/hadoop/core/trunk \
    https://svn.apache.org/repos/asf/hadoop/core/branches/branch-X.Y -m "Branching for X.Y releases"
  6. Update CHANGES.txt to add back in Trunk (unreleased changes).

  7. Update the default version in build.xml on trunk to X.Y+1.0-dev.

  8. Update the version number in src/docs/src/documentation/content/xdocs/tabs.xml on trunk to X.Y+1.0.

  9. 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/core/branches/branch-X.Y
  2. Update CHANGES.txt to include the release version and date.

  3. Regenerate the documentation.

    ant docs
  4. Update docs/releasenotes.html with release notes for this release.

  5. Update the version number in build.xml to be hadoop-X.Y.N-dev, where N is one greater than the release being made.

  6. Commit these changes.

    svn commit -m "Preparing for release X.Y.Z"
  7. 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: HADOOP-A, HADOOP-B."
  8. Tag the release candidate (R is the release candidate number):

    svn copy https://svn.apache.org/repos/asf/hadoop/core/branches/branch-X.Y \
    https://svn.apache.org/repos/asf/hadoop/core/tags/release-X.Y.Z-rcR -m "Hadoop X.Y.Z-rcR release."

Build Requirements

To build an official release, you must:

  1. Use a 64-bit Linux system, so that we can [http://hadoop.apache.org/core/docs/current/native_libraries.html build native code] for both 32- and 64-bit architectures.

  2. Have a recent version of [http://www.eclipse.org/ Eclipse] installed, so that the eclipse plugin will build.

  3. Have [http://jdiff.sourceforge.net/ JDiff] 1.1.1 or later installed.

  4. Have [http://xerces.apache.org/xerces-c/download.cgi Xerces C] 2.8.x installed.

Building

  1. Build the release & run unit tests.

    export JAVA_HOME=/path/to/32bit/jdk
    export CFLAGS=-m32
    export CXXFLAGS=-m32
    ant -Dversion=X.Y.Z -Dcompile.native=true -Dcompile.c++=true -Dlibhdfs=1 -Dlibrecordio=true -Dxercescroot=/usr/local/xerces-c -Declipse.home=/usr/lib/eclipse -Djdiff.home=/usr/local/jdiff clean package-libhdfs api-report tar test test-libhdfs
    export JAVA_HOME=/path/to/64bit/jdk
    export CFLAGS=-m64
    export CXXFLAGS=-m64
    ant -Dversion=X.Y.Z -Dcompile.native=true -Dcompile.c++=true compile-core-native compile-c++ tar
  2. Check that release file looks ok - e.g. install it and run examples from tutorial.
  3. Generate the MD5 checksum of the release file.

    md5sum hadoop-X.Y.Z.tar.gz > hadoop-X.Y.Z.tar.gz.md5
  4. 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
  5. 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
  6. Call a release vote on core-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/core/tags/release-X.Y.Z-rcR \
    https://svn.apache.org/repos/asf/hadoop/core/tags/release-X.Y.Z -m "Hadoop X.Y.Z release."
  2. Copy release files to the distribution directory and make them writable by the hadoop group.

    ssh people.apache.org
    cp -pr public_html/hadoop-X.Y.Z-candidate-0 /www/www.apache.org/dist/hadoop/core/hadoop-X.Y.Z
    cd /www/www.apache.org/dist/hadoop/core
    chgrp -R hadoop hadoop-X.Y.Z
    chmod -R g+w hadoop-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.

    ssh people.apache.org
    cd /www/www.apache.org/dist/hadoop/core
    rm -rf hadoop-A.B.C; rm stable
    ln -s hadoop-A.B.D stable
  4. Wait 24 hours for release to propagate to mirrors.
  5. Prepare to edit the website.

    svn co https://svn.apache.org/repos/asf/hadoop/core/site
  6. Add the newly tagged release to the website as an external. When adding the new branch, leave the old branches so that links do not break. Once the external is added, update your workspace to checkout the new external reference.

    svn propedit svn:externals publish/docs
    svn update
  7. Update the documentation links in author/src/documentation/content/xdocs/site.xml.

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

  9. Update the link publish/docs/current.

  10. Regenerate the site, review it, then commit it.

    ant
    firefox publish/index.html
    svn commit -m "Updated site for release X.Y.Z."
  11. Deploy your site changes.

    ssh people.apache.org
    cd /www/hadoop.apache.org/core
    svn up
  12. Copy the new Javadoc to people.apache.org:/www/hadoop.apache.org/core/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/hadoop/core/hadoop-X.Y.Z/hadoop-X.Y.Z.tar.gz '*/docs/api'
    tar xvf /www/www.apache.org/dist/hadoop/core/hadoop-X.Y.Z/hadoop-X.Y.Z.tar.gz '*/docs/jdiff'
    chmod -R 775 hadoop-X.Y.Z
    chgrp -R hadoop hadoop-X.Y.Z
    cp -rp hadoop-X.Y.Z/docs/api /www/hadoop.apache.org/core/docs/rX.Y.Z
    cp -rp hadoop-X.Y.Z/docs/jdiff /www/hadoop.apache.org/core/docs/rX.Y.Z
    rm -r hadoop-X.Y.Z
  13. Generate the jdiff API data for the new release by, in the branch directory, running

    ant -Dversion=X.Y.Z -Djdiff.home=/usr/local/jdiff api-xml

    then commit the XML file generated in docs/jdiff to both trunk and to the branch (and any intermediate branches between trunk and the branch being released).

    svn commit -m "JDiff output for release X.Y.Z"
  14. Update the jdiff.stable value in the X.Y+1 branch's build.xml (which may be trunk) to be the published release (ie. X.Y.Z).

  15. Send announcements to the user and developer lists once the site changes are visible.
  16. In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
  17. In Jira, "release" the version. Visit the "Administer Project" page, then the "Manage versions" page. You need to have the "Admin" role in Hadoop Core's Jira for this step and the next.
  18. In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.

See Also