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

These instructions have been updated for Hadoop 2.5.1 and later releases to reflect the changes to version-control (git), build-scripts and mavenization.

Earlier versions of this document are at HowToReleaseWithSvnAndAnt and HowToReleasePostMavenization

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.
  2. If you have not already done so, append your code signing key to the KEYS file. Once you commit your changes, they will automatically be propagated to the website. Also upload your key to a public key server if you haven't. End users use the KEYS file (along with the web of trust) to validate that releases were done by an Apache committer. For more details on signing releases, see Signing Releases and Step-By-Step Guide to Mirroring Releases.

  3. To deploy artifacts to the Apache Maven repository create ~/.m2/settings.xml:

    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                          http://maven.apache.org/xsd/settings-1.0.0.xsd">
      <servers>
        <server>
         <id>apache.staging.https</id>
         <username>Apache username</username>
         <password>Apache password</password>
        </server>
      </servers>
    </settings>

Branching

When releasing Hadoop X.Y.Z, the following branching changes are required. Note that a release can match more than one of the following if-conditions. For a major release, one needs to make the changes for minor and point releases as well. Similarly, a new minor release is also a new point release.

  1. Add the release X.Y.Z to CHANGES.txt files if it doesn't already exist (leave the date as unreleased for now). Commit these changes to trunk and any of branch-X, branch-X.Y if they exist.

    git commit -a -m "Adding release X.Y.Z to CHANGES.txt"
  2. If this is a new major release (i.e., Y = 0 and Z = 0)
    1. Create a new branch (branch-X) for all releases in this major release.
    2. Update the version on trunk to (X+1).0.0-SNAPSHOT

      mvn versions:set -DnewVersion=(X+1).0.0-SNAPSHOT
    3. Commit the version change to trunk.

      git commit -a -m "Preparing for (X+1).0.0 development"
  3. If this is a new minor release (i.e., Z = 0)
    1. Create a new branch (branch-X.Y) for all releases in this minor release.
    2. Update the version on branch-X to X.(Y+1).0-SNAPSHOT

      mvn versions:set -DnewVersion=X.(Y+1).0-SNAPSHOT
    3. Commit the version change to branch-X.

      git commit -a -m "Preparing for X.(Y+1).0 development"
  4. If this is a new point release (i.e., always)
    1. Create a new branch (branch-X.Y.Z) for this release.
    2. Update the version on branch-X.Y to X.Y.(Z+1)-SNAPSHOT

      mvn versions:set -DnewVersion=X.Y.(Z+1)-SNAPSHOT
    3. Commit the version change to branch-X.Y.

      git commit -a -m "Preparing for X.Y.(Z+1) development"
  5. Release branch (branch-X.Y.Z) updates:
    1. Update hadoop-project/src/site/apt/index.apt.vm to reflect the right versions, new features and big improvements.

    2. Update the version on branch-X.Y.Z TO X.Y.Z

      mvn versions:set -DnewVersion=X.Y.Z
    3. Generate releasenotes.html with release notes for this release. You generate these with:

      python ./dev-support/relnotes.py -v $(vers)
      If your release includes more then one version you may add additional -v options for each version. By default the previousVersion mentioned in the notes will be X.Y.Z-1, if this is not correct you can override this by setting the --previousVer option.
    4. Update releasenotes.html

      mv releasenotes.$(vers).html ./hadoop-common-project/hadoop-common/src/main/docs/releasenotes.html
      Note that the script generates a set of notes for HDFS, HADOOP, MAPREDUCE, and YARN too, but only common is linked from the html documentation so the indavidual ones are ignored for now.
    5. Commit these changes to branch-X.Y.Z

      git commit -a -m "Preparing for release X.Y.Z"

Now, for any branches in {trunk, branch-X, branch-X.Y, branch-X.Y.Z} that have changed, push them to the remote repo taking care of any conflicts.

git push <remote> <branch>

Creating the release candidate (X.Y.Z-RC<N>)

These steps need to be performed to create the Nth RC for X.Y.Z, where N starts from 0.

  1. Run mvn rat-check and fix any errors

    mvn apache-rat:check
  2. Set environment variable version for later steps. export version=X.Y.Z-RCN

  3. Set the release date for X.Y.Z to the current date in each CHANGES.txt file in branch-X.Y.Z and commit the changes.

    git commit -a -m "Set the release date for $version"
  4. Tag the release candidate:

    git tag -s release-$version -m "Release candidate - $version"
  5. Push branch-X.Y.Z and the newly created tag to the remote repo.
  6. Deploy the maven artifacts, on your personal computer. (You might want to do this in private and clear your history file as your gpg-passphrase is in clear text)

    mvn clean deploy -Psign,src,dist -DskipTests -Dgpg.passphrase=<your-gpg-passphrase>
  7. Use this Jenkins job to build the artifacts

  8. Check that release file looks ok - e.g. install it and run examples from tutorial.
  9. Generate the checksums of the release file.

    gpg --print-mds hadoop-${version}-src.tar.gz > hadoop-${version}-src.tar.gz.mds
    gpg --print-mds hadoop-${version}.tar.gz > hadoop-${version}.tar.gz.mds
  10. Sign the release

    gpg --armor --output hadoop-${version}-src.tar.gz.asc --detach-sig hadoop-${version}-src.tar.gz
    gpg --armor --output hadoop-${version}.tar.gz.asc --detach-sig hadoop-${version}.tar.gz
  11. Copy release files to a public place.

    ssh people.apache.org mkdir public_html/hadoop-${version}
    scp -p hadoop-${version}.tar.gz* people.apache.org:public_html/hadoop-${version}
  12. Log into Nexus, select Staging from the left navigation pane, right-click on the pushed repository, and close the release.

  13. Call a release vote on common-dev at hadoop.apache.org. Example

Publishing

In 5 days if the release vote passes, the release may be published.

  1. Update the release date in CHANGES.txt of trunk, branch-X, branch-X.Y to reflect the one in branch-X.Y.Z. Commit and push those changes.

    git commit -a -m "Set the release date for X.Y.Z"
  2. Tag the release:

    git tag -s release-X.Y.Z -m "Hadoop X.Y.Z release"
  3. Copy release files to the distribution directory
    1. Check out the corresponding svn repo if need be

      svn co https://dist.apache.org/repos/dist/release/hadoop/common/ hadoop-dist
    2. Generate new .mds files referring to the final release tarballs and not the RCs
    3. Copy the release files to hadoop-dist/hadoop-${version}
    4. Update the symlinks to current2 and stable2. The release directory usually contains just two releases, the most recent from two branches.
    5. Commit the changes

      svn ci -m "Publishing the bits for release ${version}"
  4. In Nexus, effect the release of artifacts by selecting the staged repository and then clicking Release

  5. Wait 24 hours for release to propagate to mirrors.
  6. Edit the website.
    1. Checkout the website if you haven't already

      svn co https://svn.apache.org/repos/asf/hadoop/common/site/main hadoop-common-site
    2. Update the documentation links in author/src/documentation/content/xdocs/site.xml.

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

    4. Update the news on the home page author/src/documentation/content/xdocs/index.xml.

    5. Copy the new release docs to svn and update the docs/current link, by doing the following:

      tar xvf /www/www.apache.org/dist/hadoop/core/hadoop-${version}/hadoop-${version}.tar.gz 
      cp -rp hadoop-${version}/share/doc/hadoop publish/docs/r${version}
      rm -r hadoop-${version}
      rm current2 current
      ln -s r${version} current2
      ln -s current2 current
    6. Similarly update the symlinks for stable if need be.
    7. Add the documentation changes.

      svn add publish/docs/r${version}
    8. Regenerate the site, review it, then commit it.

      ant -Dforrest.home=$FORREST_HOME -Djava5.home=/usr/local/jdk1.5
      firefox publish/index.html
      svn commit -m "Updated site for release X.Y.Z."
  7. Send announcements to the user and developer lists once the site changes are visible.
  8. In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
  9. 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.
  10. In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.

See Also

HowToRelease (last edited 2015-04-21 23:40:00 by AndrewWang)