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 using git

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Build the release & run unit tests.

    Code Block
    ant test package tar

    (warning)(warning) Don't skip the "test" part and don't just do "ant package tar"! See here for why.

  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. See this page for latest Apache guidelines.

    Code Block
    md5sumshasum -a 256 zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.md5sha256
    sha1sumshasum -a 512 zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.sha1sha512

  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 and ensure they are readable. Note that only supports SFTP, so this may be easier with a graphical SFTP client like Nautilus, Konqueror, etc.

    Code Block
    > cd public_html
    > mkdir zookeeper-X.Y.Z-candidate-0
    > cd zookeeper-X.Y.Z-candidate-0
    > put zookeeper-X.Y.Z.tar.gz*
    > bye

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


    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 release candidate tag in git to be voted upon: release-X.Y.Z-rcR
    ZooKeeper's KEYS file containing PGP keys we use to sign the release:
    Should we release this candidate?


  1. Tag the release. Do it from the release branch and push the created tag to the remote repository:

    Code Block
    # create a signed tag
    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. Check in release files to the distribution server

  3. Code Block
    svn co zookeeper_dist
    cd zookeeper_dist
    mkdir zookeeper-X.Y.Z
    # copy tgz/asc/md5/sha1checksum 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. ZooKeeper uses Jekyll/Markdown with gitpubsub. See WebSiteSetup for general instructions and tool setup/prerequisites.

    Code Block
    git clone -b website

  8. Copy the new release documentation into the _released_docs directory

    Code Block
    cd _released_docs
    mkdir rX.Y.Z
    cd rX.Y.Z
    tar xvf zookeeper-X.Y.Z.tar.gz 'zookeeper-X.Y.Z/docs'
    mv zookeeper-X.Y.Z/docs/* .
    rm -r zookeeper-X.Y.Z
    # Update the "current" doc pointer if necessary (next 2 lines)
    rm current
    ln -s rX.Y.Z current
    cd ..
    git add rX.Y.Z current
    cd ..

  9. Update the release news in
  10. Update the nav panel to include X.Y.Z in _includes/, move previous version(s) to (next step)
  11. Update to include the previous version(s)
  12. Stage changes to git

    Code Block
    git add

  13. Regenerate the site, review it, then commit it. (install Jekyll/pygments if you haven't already - see the in website branch)

    Code Block
    jekyll build
    cp -RP _released_docs _site/doc
    # at this point verify that the site is working properly - open _site/index.html
    # once you are happy move on to the next step...
    git commit -m "Updated website content for release X.Y.Z."
    git push origin website

  14. Deploy: you are now ready to deploy the changes to the public website using gitpubsub. Using the same repo as the previous step:

    Code Block
    git checkout asf-site
    rm -fr content
    mv _site content
    git add content
    # verify that the content of "content" looks proper. open content/index.html in a browser and verify, etc...
    # verify git staging looks proper - remember, we added the release docs to content/doc/rX.Y.Z and that will also be added here
    git commit -m "Website update for release X.Y.Z"
    git push origin asf-site

    If the apache zookeeper website does not update, check if the commit is mirrored into asf-site branch

  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.


Support is now available for pushing the jar artifacts to the Apache maven repository.

WARNING: the process has changed but the docs not yet updated, see


  1. add X.Y.Z to versions
  2. update the version to X.Y.Z
  3. update the lastUpdated

sign and md5sum maven-metadata.xml

Code Block
md5sum maven-metadata.xml > maven-metadata.xml.md5
gpg2 --armor --output maven-metadata.xml.asc --detach-sig maven-metadata.xml

Smoke Tests

Before the release, run the following smoke tests (at least).