Deploy to the Maven Repository.
This is done using apache-release profile, coming from the apache parent pom. This will also sign your artifacts if your settings.xml is configured as mentioned above.
The following command copies all artifacts to a temporary staging Apache mvn repository in open state:
Code Block
mvn deploy -DskipTests -Papache-release
Make the release candidate available
You can check the artifacts you just uploaded in the Apache’s Nexus at repository.apache.org using your Apache ID. Click 'Staging Repositories' and look for a new ZooKeeper repository with a status of 'Open'. Check that all the artifacts and pom files are available. As long as this is in open state, you can re-upload your files. Or just use 'Drop' on the staging repo.
If it checks out, close the repo using the 'Close' button. The repository must be closed before a public URL to it becomes available. It may take a few minutes for the repository to close. Once complete you’ll see a public URL to the repository in the Nexus UI. You may also receive an email with the URL. Provide the URL to the temporary staging repository in the email that announces the release candidate.
When the release vote concludes successfully, return here and click the 'Release' button to release the artifacts to central. The release process will automatically drop and delete the staging repository.

***************

**************

Branching

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

...

Create a branch for the release series:

Code Block

git clone -b master https://gitbox.apache.org/repos/asf/zookeeper.git

# create new branch-X.Y from master branch
git checkout -b branch-X.Y master
 
# push the new branch to remote repo
git push <remote> branch-X.Y

Checkout master branch.

Code Block
git checkout master

...

Commit these changes to master.

Code Block

# check for modified files
git status
 
# add individual files one by one
git add build.xml
git add src/c/configure.ac
git add src/c/include/zookeeper_version.h
 
# commit and push the changes to remote repo
git commit -m "Preparing for X.Y+1.0 development"
git push <remote> master

Updating the release branch

These operations take place in the release branch:

Check out the branch with:

Code Block
git clone -b branch-X.Y https://gitbox.apache.org/repos/asf/zookeeper.git

...

Create a branch for X.Y.Z (the current release candidate)

Code Block
git branch branch-X.Y.Z git push <remote> branch-X.Y.Z

...

Code Block

# check for modified files
git status

# add modified files one by one
git add <modified files>
 
# commit and push the changes to remote repo branch-X.Y
git commit -m "Prepare for the next release: update the version to X.Y.(Z+1)-SNAPSHOT"
git push <remote> branch-X.Y

Checkout the active point release branch - this is where you will be creating the release candidate

Code Block
git checkout branch-X.Y.Z

If not already done, cherry-pick desired commits into branch-X.Y.Z. If cherry-picks are done from other than branch-X.Y ensure that those changes are also committed to branch-X.Y. If there are conflicts, then it is preferable to produce a new patch for this branch, review it separately and commit it via JIRA. Please refer HowToContribute and Committing changes page for pushing changes to the project.

Code Block
# The -x option records the source commit, and reuses the original commit message git cherry-pick -x <commit-hash>

...

Commit these changes.

Code Block

# check for modified files
git status

# add modified files one by one
git add <modified files>
 
# commit and push the changes to remote repo branch-X.Y
git commit -m "Preparing for release X.Y.Z"
git push <remote> branch-X.Y.Z

Tag the release candidate (R is the release candidate number, and starts from 0):

Code Block
# create a signed tag 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

Building

...

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.

...

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

...

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

...

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

...

Click on Log In in the upper right corner. Log in using your apache user name and password.
In the left navigation pane, select Staging Repositories.
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.)
Click the Close button above the Repository names. This makes your release candidate available at the Staging level.
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.
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

...

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'

...

Click on 'Staging repositories'.
Select the repository corresponding to the release candidate.
Click on the 'Release' button and follow instructions.

...

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

...

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

...

Smoke Tests

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

Run unit tests on different hardwares: mac, windows, linux.

Space shortcuts

Child pages

Versions Compared

Old Version 12

New Version 13

Key

Branching

Updating the release branch

Building

Publishing

Smoke Tests

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 12

New Version 13

Key

Branching

Updating the release branch

Building

Publishing

Smoke Tests