This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • HowToRelease

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 57


  1. Check out the branch with:

    Code Block
    svn co

    git clone -b branch-X.Y

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

    Code Block
    cd branch-X.Y
    svn merge -rR1:R2 ../trunk .
    svn commit -m "Merge -r R1:R2 from trunk to X.Y branch. Fixes: ZOOKEEPER-A, ZOOKEEPER-B."
  3. Do a final pass regeneration of docs by running "ant -Dforrest.home=<path to Forrest> clean docs".  If there are any modifications, then they'll show up under the docs folder.  If there are any changes, then commit them.  However, DO NOT commit changes in docs/releasenotes.html or docs/releasenotes.pdf.  (Release notes are handled in a separate step.)  Release notes should be regenerated each time a documentation patch is committed.  This final pass before the release is intended to catch mistakes in case this step was missed at commit time.
  4. 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).Also, update CHANGES.txt with the committed jira details targeted for this release version. As we follow PR merging, jira info is not updated in this file while committing.
  5. Update docs/releasenotes.html with release notes for this release. You can get the HTML by following the "Release Notes" link for the relevant release on the tab in Jira. Note that you need to exclude the won't fix or invalid tickets.
  6. TODO - document howto generate the release notes using the new mechanism
  7. Update the version number in build.xml to be ''X.Y.Z''
  8. Update the version number in src/c/include/winconfig.h, src/c/, and src/c/include/zookeeper_version.h to be ''X.Y.Z''
  9. Update the copyright years in NOTICE.txt if it's outdated.
  10. Commit these changes.

    Code Block
    svn commit -m "Preparing for release X.Y.Z"
     git commit -a -m "Preparing for release X.Y.Z"
     git push <remote> <branch>
  11. Tag the release candidate (R is the release candidate number, and starts from 0):

    Code Block
    svn copy \ -m "ZooKeeper X.Y.Z-rcR release."
     git tag -s release-X.Y.Z-rcR -m "ZooKeeper X.Y.Z-rcR release."
     Push the newly created rc tag to the remote repo.
     git push <remote> release-X.Y.Z-rcR


  1. Build the release & run unit tests.

    Code Block
    ant test package tar
  2. Untar the generated zookeeper-X.Y.Z.tar.gz and do the following:
    1. Sign the toplevel zookeeper-X.Y.Z.jar

      Code Block
      gpg --armor --output zookeeper-X.Y.Z.jar.asc --detach-sig zookeeper-X.Y.Z.jar
    2. Sign each file in dist-maven

      Code Block
      gpg --armor --output file.asc --detach-sig file
  3. Tar/GZ the release directory as zookeeper-X.Y.Z.tar.gz

    Code Block
    tar -caf zookeeper-X.Y.Z.tar.gz zookeeper-X.Y.Z
  4. Generate the MD5/SHA1 checksums for the release artifact.

    Code Block
    md5sum zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.md5
    sha1sum zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.sha1
  5. Sign the release

    Code Block
    gpg --armor --output zookeeper-X.Y.Z.tar.gz.asc --detach-sig zookeeper-X.Y.Z.tar.gz
  6. Check that release file looks ok - e.g. install it and run examples from tutorial.
    1. untar the release artifact in a test directory
  7. Copy release files to a public place.

    Code Block
    ssh mkdir public_html/zookeeper-X.Y.Z-candidate-0
    scp -p zookeeper-X.Y.Z.tar.gz*
  8. Stage the release artifacts to the Apache Nexus repository
    1. Create ~/.m2/settings.xml introducing the values that are specific to you:

      Code Block

      See for details on encrypting the passwords rather than leaving them in the clear.

    2. Run the following on the branch check out

      Code Block
      ant mvn-deploy -Dstaging=true
    3. Enter Apache Nexus and do the following:
      1. Click on Log In in the upper right corner. Log in using your apache user name and password.  

      2. In the left navigation pane, select Staging Repositories.  

      3. Identify the release candidate you just pushed, by your user name (in parentheses as part of the "Repository" name) and the "Created On" date. Click on the check box to the left of your Repository name to select it. (If you accidentally click on the Repository name itself, another tab will pop open. If so, just close it.)  
      4. Click the Close button above the Repository names. This makes your release candidate available at the Staging level.  

      5. If you have previously staged an older release candidate with the same version number, and it is still showing in the Repository list, you must select and Drop the old one now.  

      6. Confirm that your new release candidate is visible at with correct file modification dates.

  9. Call for a release vote on dev (note dev@ and not user@, the user list is for discussion of released software only) at Here is a sample email (from 3.4.6 release):

    In the below release candidate dev mail format, we need to change the 'The tag to be voted upon:' section like,

    "The RC tag in git to be voted upon: release-X.Y.Z-rcR"

    Code Block
    Subject: [VOTE] Apache ZooKeeper release 3.4.6 candidate 0
    This is a bugfix release candidate for 3.4.6. It fixes 117 issues, including issues that
    affect leader election, Zab, and SASL authentication.
    The full release notes is available at:
    *** Please download, test and vote by March 9th 2014, 23:59 UTC+0. ***
    Source files:
    Maven staging repo:
    The tag to be voted upon:
    ZooKeeper's KEYS file containing PGP keys we use to sign the release:
    Should we release this candidate?


  1. Tag the release:

    Code Block
    svn move \ -m "ZooKeeper X.Y.Z release."
     git tag -s release-X.Y.Z -m "ZooKeeper X.Y.Z release."
     Push the newly created release tag to the remote repo.
     git push <remote> release-X.Y.Z
  2. Update the version number to the next logical SNAPSHOT version (e.g. X.Y.Z to X.Y.Z+1-SNAPSHOT)

  3. Check in release files to the distribution server

    Code Block
    svn co zookeeper_dist
    cd zookeeper_dist
    mkdir zookeeper-X.Y.Z
    # copy tgz/asc/md5/sha1 files from your public_html to zookeeper-X.Y.Z
    svn add zookeeper-X.Y.Z
    svn ci -m "Add ZooKeeper X.Y.Z release"


    1. After checking in the release, you'll receive an automated email from with a link requesting additional details about the release.  This form must be completed by a PMC member.  If you are a PMC members, follow the link and complete the form.  If you are not a PMC member, forward the email to and ask for assistance from a PMC member.
  4. 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.

    Code Block
    cd zookeeper_dist
    # don't do the following rm for the time being, until we are sure the new rel is actually stable --> ### rm -rf zookeeper-A.B.C
    rm stable; rm current
    ln -s zookeeper-A.B.D stable
    ln -s zookeeper-A.B.D current
    svn ci -m 'Updating links'  
  5. Release the Maven artifacts on Apache Nexus:
    1. Click on 'Staging repositories'.
    2. Select the repository corresponding to the release candidate.
    3. Click on the 'Release' button and follow instructions.
  6. Wait 24 hours for release to propagate to mirrors.
  7. Prepare to edit the website.

    Code Block
    svn co
  8. Copy the new release documentation into the content/doc directory

    Code Block
    cd site/trunk/content/doc
    mkdir rX.Y.Z
    cd rX.Y.Z
    tar xvf /www/ 'zookeeper-X.Y.Z/docs'
    mv zookeeper-X.Y.Z/docs/* .
    rm -r zookeeper-X.Y.Z
    cd ..
    svn add rX.Y.Z
  9. Update the release news in site/trunk/content/releases.textile
  10. Update the nav panel to include X.Y.Z (which may now be "current") site/trunk/templates/sidenav.textile
  11. Regenerate the site, review it, then commit it. (checkout if you haven't already)

    Code Block
    cd site/trunk
    .../apache_cms_build/ --source-base . --target-base /tmp/sitegen
    <open /tmp/sitegen/index.html in your browser and verify the site>
    svn commit -m "Updated site for release X.Y.Z."
  12. Update the "current" doc pointer if necessary (as CMS doesn't currently support symlinks in build/staging we need to push this directly to production)

    Code Block
    svn co
    cd content/doc
    rm current
    ln -s rX.Y.Z current
    svn commit -m "Updated current pointer for release X.Y.Z"
  13. Review your changes on the staging site:
  14. Deploy your site changes.

    Code Block
    publish the site changes
  15. Send announcements to the user and developer lists once the site changes are visible. Here is a sample email:

    No Format
    Subject: [ANNOUNCE] Apache ZooKeeper X.Y.Z
    The Apache ZooKeeper team is proud to announce Apache ZooKeeper version X.Y.Z
    ZooKeeper is a high-performance coordination service for distributed
    applications. It exposes common services - such as naming,
    configuration management, synchronization, and group services - in a
    simple interface so you don't have to write them from scratch. You can
    use it off-the-shelf to implement consensus, group management, leader
    election, and presence protocols. And you can build on it for your
    own, specific needs.
    For ZooKeeper release details and downloads, visit:
    ZooKeeper X.Y.Z Release Notes are at:
    We would like to thank the contributors that made the release possible.
    The ZooKeeper Team
  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 ZooKeeper's Jira for this step and the next.
  18. In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.