During 3.5 development we migrated from ANT to Maven, but we were not using the Maven Release Plugin yet.
If you are going to release 3.6 or newer please follow the current procedure.
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:
If you have any issues (i.e. "error: gpg failed to sign the data") when trying to sign your commit (tag), refer to this gist.
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/
Make sure your settings.xml in ~/.m2 contain logins for apache repos, and your signing key is published and configured here.
Please follow the instructions here to encrypt your Apache credentials: https://maven.apache.org/guides/mini/guide-encryption.html
<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 stage a release -->
<server>
<id>apache.staging.https</id>
<username>YOUR_APACHE_ID</username>
<password>YOUR_APACHE_PASSWORD</password>
</server>
<server>
<id>apache.releases.https</id>
<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.
Before the release, run the following smoke tests (at least).
Check out the branch you are making the release of:
git clone -b branch-X.Y https://gitbox.apache.org/repos/asf/zookeeper.git |
If you are creating a point release (almost always the case) then follow this step. The exception to this is typically only when creating a new release candidate because the previous candidate failed during voting (rc0 failed and you are creating rc1+) – in which case skip this step.
Create a branch for X.Y.Z (the current release candidate)
VERSION=X.Y.Z NEWVERSION=X.Y.(Z+1) BRANCH_NAME=branch-$VERSION REMOTE=origin git branch $BRANCH_NAME git push $REMOTE $BRANCH_NAME |
Update to next SNAPSHOT version
mvn clean org.codehaus.mojo:versions-maven-plugin:2.7:set -DgenerateBackupPoms=false -DnewVersion=$NEWVERSION-SNAPSHOT |
Also update the version number in zookeeper-client/zookeeper-client-c/configure.ac, zookeeper-client/zookeeper-client-c/CMakeLists.txt, and zookeeper-client/zookeeper-client-c/include/zookeeper_version.h to the next logical SNAPSHOT version (e.g. X.Y.Z to X.Y.(Z+1)-SNAPSHOT)
cd zookeeper-client/zookeeper-client-c sed -i s/$VERSION/$NEWVERSION/g configure.ac sed -i s/$VERSION/$NEWVERSION/g CMakeLists.txt cd ../.. grep -r $NEWVERSION * |
Commit these changes.
# 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.Z |
Checkout the active point release branch - this is where you will be creating the release candidate
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.
# The -x option records the source commit, and reuses the original commit message git cherry-pick -x <commit-hash> |
Update zookeeper-docs/src/main/resources/markdown/releasenotes.md 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%3Aroadmap-panel tab in Jira. Note that you need to exclude the won't fix or invalid tickets.
Hints for editing releasenotes.md (using vim) - you can skip 'c' parameter, it tells vim to ask for all replacement:
:%s/<\/h2>//gc :%s/<li>\[<a href='\(.*\)'>\(ZOOKEEPER-[0-9]\+\)<\/a>\] - \+/* [\2](\1) - /gc :%s/<\/li>\n//gc |
Update versions in pom.xml (remove SNAPSHOT):
mvn clean org.codehaus.mojo:versions-maven-plugin:2.7:set -DgenerateBackupPoms=false -DnewVersion=$VERSION |
Make sure the version number is correct in zookeeper-client/zookeeper-client-c/configure.ac, zookeeper-client/zookeeper-client-c/CMakeLists.txt, and zookeeper-client/zookeeper-client-c/include/zookeeper_version.h
Commit these changes.
# 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-X git commit -m "Preparing for release $VERSION" git push <remote> branch-X.Y.Z |
Run spotBugs, checkstyle and rat checks:
git clean -xdf mvn clean apache-rat:check -DskipTests -Pfull-build mvn clean install checkstyle:check spotbugs:check -DskipTests -Pfull-build |
Tag the release candidate (R is the release candidate number, and starts from 0):
# 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 |
If you have issues signing the tag, refer to this gist.
Build the projects with maven (we are skipping runit the unit tests here, but you should run them at least once on the release branch before continuing)
Ensure that you are using JDK8 and Maven 3.6+
There is no need to build the C client or "contrib" packages
mvn -v mvn clean install -DskipTests |
Sign the tarballs:
cd zookeeper-assembly/target gpg --armor --output apache-zookeeper-$VERSION-bin.tar.gz.asc --detach-sig apache-zookeeper-$VERSION-bin.tar.gz gpg --armor --output apache-zookeeper-$VERSION.tar.gz.asc --detach-sig apache-zookeeper-$VERSION.tar.gz |
try to build the sources with
mvn clean install -DskipTests -Pfull-build |
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.
sftp home.apache.org > cd public_html > mkdir zookeeper-$VERSION-candidate-0 > cd zookeeper-$VERSION-candidate-0 > put zookeeper-$VERSION.tar.gz* > bye |
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:
mvn deploy -DskipTests -Papache-release |
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.
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):
Release Manager Signature |
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:
# 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 |
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" --username <your apache user ID> |
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.
cd zookeeper_dist svn rm 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' |
Prepare to edit the website. ZooKeeper uses Jekyll/Markdown with gitpubsub. See WebSiteSetup for general instructions and tool setup/prerequisites.
git clone -b website https://gitbox.apache.org/repos/asf/zookeeper.git |
Copy the new release documentation into the _released_docs directory
cd _released_docs mkdir rX.Y.Z cd rX.Y.Z tar xvf apache-zookeeper-X.Y.Z-bin.tar.gz --strip-components 2 'apache-zookeeper-X.Y.Z-bin/docs' rm apache-zookeeper-X.Y.Z-bin.tar.gz # Update the "current" doc pointer if necessary (next 2 lines) cd .. rm current ln -s rX.Y.Z current git add rX.Y.Z current cd .. |
Stage changes to git
git add releases.md documentation.md html/header.html |
Regenerate the site, review it, then commit it. (for possible prerequisites, see the README.md in website branch)
mvn clean install cp -RP _released_docs target/html/doc # at this point verify that the site is working properly - open target/html/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:
git checkout asf-site rm -fr content mv target/html 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:
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: https://zookeeper.apache.org/releases.html ZooKeeper X.Y.Z Release Notes are at: https://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 |
Before the release, run the following smoke tests (at least).