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:
1. svn co https://dist.apache.org/repos/dist/release/zookeeper/ zookeeper_dist
2. cd zookeeper_dist.
3. edit the KEYS file. See the top of the KEYS file for instructions on how to edit this file
4. svn ci
Upload digest to your account on id.apache.org (gpg2 --fingerprint)

Configuring maven

Make sure your settings.xml in ~/.m2 contain logins for apache repos, and your signing key is published and configured here.

Useful Links and Background:

Apache infra page: https://cwiki.apache.org//confluence/display/INFRA/Index

Apache self-service page - now allows for forcing git repo sync: https://selfserve.apache.org/

Important Notes

when updating JIRA be sure to use the "batch change" operator under the "tools" menu. Disable email notifications when using batch change, subsequent to large JIRA operations (moving issues btw releases, closing JIRAs after a release, etc...) send email to the dev@ list detailing the changes.

Configuring maven

Make sure your settings.xml in ~/.m2 contain logins for apache repos, and your signing key is published and configured here.

Code Block

language	xml
title	.m2 settings

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

Code Block

language	xml
title	.m2 settings

<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>
    <!- To publish a snapshot -->
    <server>
      <id>apache.snapshots.https</id>
      <username>YOUR_APACHE_ID</username>
      <password>YOUR_APACHE_PASSWORD</password>
    </server>

    <!-- To stagepublish a releasesnapshot -->
    <server>
      <id>apache.stagingsnapshots.https</id>
      <username>YOUR_APACHE_ID</username>
      <password>YOUR_APACHE_PASSWORD</password>
    </server>

  </servers>

  <profiles>  <!-- To stage a release -->
    <profile><server>
      <id>apache-release<.staging.https</id>
      <properties>
<username>YOUR_APACHE_ID</username>
      <password>YOUR_APACHE_PASSWORD</password>
    </server>
  </servers>

  <profiles>
    <profile>
      <id>apache-release</id>
      <properties>
	    <!-- gpg --list-keys will show you your keyname ( something like 00A5F21E) -->
    	<gpg.keyname>YOUR_KEYNAME</gpg.keyname>
  		<gpg.passphrase>YOUR_KEY_PASSWORD</gpg.passphrase>
      </properties>
    </profile>
  </profiles>
</settings>

For a more detailed steps, check out How To Release page for Hadoop. It is used as a base.

Making a release candidate

Setting up maven to sign artifacts

Maven will sign the artifacts for you, but you need to configure settings.xml in your local repository (.m2 folder in your user library).

Useful Links and Background:

Apache infra page: https://cwiki.apache.org//confluence/display/INFRA/Index

Apache self-service page - now allows for forcing git repo sync: https://selfserve.apache.org/

Important Notes

<gpg.keyname>YOUR_KEYNAME</gpg.keyname>
  		<gpg.passphrase>YOUR_KEY_PASSWORD</gpg.passphrase>
      </properties>
    </profile>
  </profiles>
</settings>

For a more detailed steps, check out How To Release page for Hadoop. It is used as a base.

Making a release candidate

Publishing

Once three PMC members have voted for a release, it may be published.

Smoke Tests

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

Run unit tests on different hardwares: mac, windows, linuxwhen updating JIRA be sure to use the "batch change" operator under the "tools" menu. Disable email notifications when using batch change, subsequent to large JIRA operations (moving issues btw releases, closing JIRAs after a release, etc...) send email to the dev@ list detailing the changes.

Branching

Skip this section if this is NOT the first release in a series (i.e. release X.Y.0).

...

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.

Untar the generated zookeeper-X.Y.Z.tar.gz and do the following:

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

Sign each file in dist-maven

Code Block
for i in dist-maven/.jar dist-maven/.pom; do gpg --armor --output $i.asc --detach-sig $i; done

Tar/GZ the release directory as zookeeper-X.Y.Z.tar.gz
Code Block
tar czf zookeeper-X.Y.Z.tar.gz zookeeper-X.Y.Z

Generate the checksums for the release artifact. See this page for latest Apache guidelines.

Code Block
shasum -a 256 zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.sha256 shasum -a 512 zookeeper-X.Y.Z.tar.gz > zookeeper-X.Y.Z.tar.gz.sha512

Sign the release

Code Block
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.
1. untar the release artifact in a test directory
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

Stage the release artifacts to the Apache Nexus repository

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.

Run the following on the branch check out
Code Block
ant mvn-deploy -Dstaging=true
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.

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?

Publishing

Once three PMC members have voted for a release, it may be published.

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

Check in release files to the distribution server

Code Block

svn co https://dist.apache.org/repos/dist/release/zookeeper/ zookeeper_dist
cd zookeeper_dist
mkdir zookeeper-X.Y.Z
# copy tgz/asc/checksum 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"

After checking in the release, you'll receive an automated email from reporter.apache.org 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 dev@zookeeper.apache.org and ask for assistance from a PMC member.

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
rm -rf zookeeper-A.B.C # apache folks don't like old releases hanging around - they are available in the archive if people need access
rm stable; rm current
ln -s zookeeper-A.B.D stable
ln -s zookeeper-A.B.D current
svn ci -m 'Updating links'

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.
Wait 24 hours for release to propagate to mirrors.
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 https://gitbox.apache.org/repos/asf/zookeeper.git

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

Update the release news in releases.md
Update the nav panel to include X.Y.Z in _includes/sidenav.md, move previous version(s) to documentation.md (next step)
Update documentation.md to include the previous version(s)
Stage changes to git
Code Block
git add releases.md documentation.md

Regenerate the site, review it, then commit it. (install Jekyll/pygments if you haven't already - see the README.md 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

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 github.com/apache/zookeeper asf-site branch

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:
http://zookeeper.apache.org/releases.html

ZooKeeper X.Y.Z Release Notes are at:
http://zookeeper.apache.org/doc/rX.Y.Z/releasenotes.html

We would like to thank the contributors that made the release possible.

Regards,

The ZooKeeper Team

In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
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.
In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.

Smoke Tests

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

...

Space shortcuts

Child pages

Versions Compared

Old Version 2

New Version 3

Key

Configuring maven

Useful Links and Background:

Important Notes

Configuring maven

Making a release candidate

Setting up maven to sign artifacts

Useful Links and Background:

Important Notes

Making a release candidate

Publishing

Smoke Tests

Branching

Publishing

Smoke Tests

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 2

New Version 3

Key

Configuring maven

Useful Links and Background:

Important Notes

Configuring maven

Making a release candidate

Setting up maven to sign artifacts

Useful Links and Background:

Important Notes

Making a release candidate

Publishing

Smoke Tests

Branching

Publishing

Smoke Tests