Setting up the signing keys
Before you do a release you'll need a signing key that is registered with apache. If you already have one, you can skip this section. Otherwise, here are the steps to do:
- use gpg2 --gen-key to generate a new key. Make sure that the key size is 4096 bits, the key doesn't expire, and use CODE SIGNING KEY for the comment.
- Now you need to register your key at http://pgp.mit.edu/ using the output of gpg --armor --export <keyid>
- Add your key to the KEYS file:
- check out http://svn.apache.org/repos/asf/zookeeper/dist
- edit the KEYS file
- add the output of gpg2 --armor --fingerprint --list-sigs <keyid> and gpg2 --armor --export <keyid> to the file
- commit
Important Notes
- when updating JIRA be sure to use the "batch" operator. Disable email notifications when using batch, subsequent to large JIRA operations (moving issues btw releases, closing JIRAs after a release, etc...) send email to the dev@ list detailing the changes.
Updating the release branch
These operations take place in the release branch:
- Check out the branch with:
svn co https://svn.apache.org/repos/asf/hadoop/common/branches/branch-X.Y
- 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."
- 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).
- Update src/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 https://issues.apache.org/jira/browse/ZOOKEEPER?report=com.sourcelabs.jira.plugin.portlet.releases:releases-projecttab#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel tab in Jira.
- Update the version number in build.xml to be ''X.Y.Z''
- Update the version number in src/c/configure.ac and src/c/include/zookeeper_version.h to be ''X.Y.Z''
- Commit these changes.
svn commit -m "Preparing for release X.Y.Z"
- Tag the release candidate (R is the release candidate number, and starts from 0):
svn copy https://svn.apache.org/repos/asf/zookeeper/branches/branch-X.Y \ https://svn.apache.org/repos/asf/zookeeper/tags/release-X.Y.Z-rcR -m "ZooKeeper X.Y.Z-rcR release."
Building
- Build the release & run unit tests. This is captured in http://svn.apache.org/viewvc/hadoop/nightly/hudsonBuildHadoopRelease.sh?view=markup.
ant test package tar
- Untar the generated zookeeper-X.Y.Z.tar.gz and do the following:
- Sign the toplevel zookeeper-X.Y.Z.jar
gpg --armor --output zookeeper-X.Y.Z.jar.asc --detach-sig file zookeeper-X.Y.Z.jar
- Generate the MD5/SHA1 checksums for each file in dist-maven
md5sum file > file.md5 sha1 file > file.sha1
- Sign each file in dist-maven
gpg --armor --output file.asc --detach-sig file
- Sign the toplevel zookeeper-X.Y.Z.jar
- Tar/GZ the release directory as zookeeper-X.Y.Z.tar.gz
tar -caf zookeeper-X.Y.Z.tar.gz zookeeper-X.Y.Z
- Generate the MD5/SHA1 checksums for the release artifact.
md5sum zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.md5 sha1 zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.sha1
- Sign the release
gpg --armor --output zookeeper-X.Y.Z.tar.gz.asc --detach-sig zookeeper-X.Y.Z.tar.gz
- Check that release file looks ok - e.g. install it and run examples from tutorial.
- untar the release artifact in a test directory
- Copy release files to a public place.
ssh people.apache.org mkdir public_html/zookeeper-X.Y.Z-candidate-0 scp -p zookeeper-X.Y.Z.tar.gz* people.apache.org:public_html/zookeeper-X.Y.Z-candidate-0
- Call a release vote on dev at zookeeper.apache.org.
Maven
Support is now available for pushing the jar artifacts to the Apache maven repository.
1) copy the jar/pom/etc... into the appropriate directory
http://people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/hadoop/zookeeper/
full details here:http://www.apache.org/dev/repository-faq.html
the files are sync'd daily, and ivy finds it.
the maven metadata files located on people.a.o have to be updated/resigned manually
Smoke Tests
Before the release, run the following smoke tests (at least).
- Run unit tests on different hardwares: mac, windows, linux.