Page History

...

1. Build the release & run unit tests.

   Code Block
   ant test package tar

    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.

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

   Code Block
   sftp home.apache.org > 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

      <settings>   <servers>      <server>        <id>apache.snapshots.https</id>        <username>XXXXXXX</username>        <password>XXXXXXXX</password>      </server>      <server>        <id>apache.staging.https</id>        <username>XXXXXXX</username>        <password>XXXXXXX</password>      </server>    </servers>    <profiles>      <profile>        <id>gpg</id>        <properties>          <gpg.passphrase>XXXXXXX</gpg.passphrase>        </properties>      </profile>    </profiles> </settings>

      See http://maven.apache.org/guides/mini/guide-encryption.html 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 https://repository.apache.org/content/groups/staging/org/apache/zookeeper/zookeeper/ 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 zookeeper.apache.org. Here is a sample email (from 3.4.6 release):

    

   Code Block
   language text
   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: https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310801&version=12323310 *** Please download, test and vote by March 9th 2014, 23:59 UTC+0. *** Source files: http://people.apache.org/~fpj/zookeeper-3.4.6-candidate-0/ Maven staging repo: https://repository.apache.org/content/groups/staging/org/apache/zookeeper/zookeeper/3.4.6/ 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: http://www.apache.org/dist/zookeeper/KEYS Should we release this candidate?

   
   

...