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:
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> </servers> <server> <id>apache.releases.https</id> <username>YOUR_APACHE_ID</username> <password>YOUR_APACHE_PASSWORD</password> </server> <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 a fresh new copy of the repository:
git clone https://gitbox.apache.org/repos/asf/zookeeper.git cd zookeeper |
We are going to perform the full procedure using docker, this way we are sure that the binary artifacts are built using a know environment:
Enter the docker environment (this should work on Mac and on Linux).
In some environment with SELinux you have to enable "permissive mode" ("sudo setenforce Permissive")
dev/docker/run.sh |
Build Java anc C sources, run tests and test GPG signature
export GPG_TTY=$(tty) mvn clean install -Pfull-build -Papache-release -DskipTests mvn dependency-check:check |
Create a branch for X.Y.Z (the current release candidate)
RC_NUM=0 BRANCH_NAME=branch-3.6 WORK_BRANCH=branch-3.6.0 RELEASE_DEVELOPMENT_VERSION=3.6.1-SNAPSHOT RELEASE_VERSION=3.6.0 MASTER_DEVELOPMENT_VERSION=3.7.0-SNAPSHOT TAG=release-$RELEASE_VERSION-$RC_NUM git checkout master git pull --rebase git clean -xdf mvn release:clean mvn release:branch \ -DbranchName=$BRANCH_NAME \ -DdevelopmentVersion=$MASTER_DEVELOPMENT_VERSION \ -Pfull-build |
That command will:
The goal "branch" in Maven Release plugin does not support "preparationGoals" and "completionGoals" so we have to to manually change the version inside the C-client
So now you have to set the version in zookeeper-client/zookeeper-client-c
In 3.7.0 we have:
Then push a commit with the fix.
It is now time to create CI jobs for the new branch, if you do not have permissions to edit CI configuration just send an email to dev@zookeeper.apache.org
If you are releasing a version that is not the first one of a main branch just checkout the release branch
RC_NUM=0 BRANCH_NAME=branch-3.6 WORK_BRANCH=branch-3.6.1 RELEASE_DEVELOPMENT_VERSION=3.6.2-SNAPSHOT RELEASE_VERSION=3.6.1 TAG=release-$RELEASE_VERSION-$RC_NUM git checkout $BRANCH_NAME git pull git push --dry-run |
If you are releasing a version that is not the first one of a main branch just checkout the release branch
RC_NUM=0 BRANCH_NAME=branch-3.6 WORK_BRANCH=branch-3.6.0 RELEASE_DEVELOPMENT_VERSION=3.6.1-SNAPSHOT RELEASE_VERSION=3.6.0 TAG=release-$RELEASE_VERSION-$RC_NUM git checkout $BRANCH_NAME git checkout -b $WORK_BRANCH git pull git push --set-upstream origin $WORK_BRANCH git status # you are now in release-x.y.z branch |
Update the copyright years in NOTICE.txt if it's outdated.
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 thehttps://issues.apache.org/jira/projects/ZOOKEEPER?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased 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 |
Push these changes to the $WORK_BRANCH (release-3.6.0) and to the $RELEASE_BRANCH (branch-3.6) (no review is needed at this point)
In case you have to run more than one RC you have to update the release notes every time and push them to those two branches.
Run spotBugs, checkstyle, rat and OWASP checks:
git checkout $WORK_BRANCH git clean -xdf # perform quality checks mvn clean apache-rat:check -DskipTests -Pfull-build -Papache-release mvn clean install checkstyle:check spotbugs:check -DskipTests -Pfull-build -Papache-release mvn dependency-check:check |
git checkout $WORK_BRANCH git clean -xdf mvn release:prepare \ -DautoVersionSubmodules=true \ -DreleaseVersion=$RELEASE_VERSION \ -Dtag=$TAG \ -DdevelopmentVersion=$RELEASE_DEVELOPMENT_VERSION \ -Darguments='-DskipTests=true -Pfull-build,apache-release' \ -Pfull-build,apache-release |
see details in
The command above perform the following activities:
Using the same directory in which you run "release:prepare" perform these are steps
Maven Release Plugin uses release.properties files prepared by release:prepare
There is no need to build the C client or "contrib" packages
mvn release:perform -Darguments='-DskipTests=true -Papache-release' -Papache-release |
Check that release file looks ok - e.g. install it and run examples from tutorial.
mvn clean install -DskipTests -Pfull-build |
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.
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.
Copy release files to a public place and ensure they are readable.
# Staged artifacts built by "release:perform" are in target/checkout ZKHOME=where you have your work directory "zookeeper" svn co https://dist.apache.org/repos/dist/dev/zookeeper/ zookeeper_dev cd zookeeper_dev mkdir zookeeper-$VERSION-candidate-0 cd zookeeper-$VERSION-candidate-0 cp $ZKHOME/target/checkout/target/*.tar.gz* . cp $ZKHOME/target/checkout/zookeeper-assembly/target/*-bin.tar.gz* . rm *.asc.sha512 mkdir website cp -r $ZKHOME/target/checkout/zookeeper-docs/target/html/* website/ cd .. svn add zookeeper-$VERSION-candidate-0 svn ci -m "Add ZooKeeper X.Y.Z release candidate 0" |
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):
This is a release candidate for 3.8.0. It is a major release and it introduces a lot of new features, most notably: The full release notes is available at: https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310801&version=12349587 *** Please download, test and vote by February 28th 2022, 23:59 UTC+0. *** Source files: Maven staging repo: The release candidate tag in git to be voted upon: release-3.8.0-1 ZooKeeper's KEYS file containing PGP keys we use to sign the release: The staging version of the website is:
Release Manager Signature |
In case you get a -1 you have to work together with the community in order to see if that vote is a real blocker for the release or not.
In case it is a real blocker we have to fix the problem and cherry-pick the fix to $BRANCH_NAME and to $WORK_BRANCH
Send an explicit email in answer to the VOTE thread and state that current RC VOTE is cancelled.
"Drop" the Maven Staging Repository at repository.apache.org
Then when you are okay restart from "Perform a release on branch" step
Once three PMC members have voted for a release, it may be published.
Subject: [RESULT] [VOTE] Apache ZooKeeper release 3.6.0 candidate 0 I'm happy to announce that we have unanimously approved this release. There are 7 approving votes, 5 of which are binding: - approver 1... - approver 2...(binding) - approver 3... There are no disapproving votes. I will promote the artifacts and complete the release procedure. Thanks to every one who contributed to this great release ! Release Manager Signature |
Update the version in $BRANCH_NAME (like branch-3.6), the Maven Release plugin pushed it to the WORK_BRANCH, you can cherry pick it but in case of conflict (if the branch diverged) you can do it with this command
git checkout $BRANCH_NAME git pull mvn release:update-versions -DdevelopmentVersion=$RELEASE_DEVELOPMENT_VERSION -Pfull-build # verify that we are committing only pom.xml files git status git diff git add . git commit -m "Start ZooKeeper $RELEASE_DEVELOPMENT_VERSION" git push |
Tag the release. Do it from the release branch and push the created tag to the remote repository, drop the $WORK_BRANCH:
git checkout $TAG # create a signed tag RELEASE_TAG=release-$RELEASE_VERSION git tag -s $RELEASE_TAG -m "ZooKeeper $RELEASE_VERSION release." git branch -D $WORK_BRANCH git push -d origin $WORK_BRANCH # push the newly created release tag to the remote repo (it should be "origin" if you cloned a frash new copy of apache repo). git push origin $RELEASE_TAG |
# copy locally the staged artifacts and the website svn co https://dist.apache.org/repos/dist/dev/zookeeper/ zookeeper_dev cd zookeeper_dev svn rm https://dist.apache.org/repos/dist/dev/zookeeper/zookeeper-$RELEASE_VERSION-candidate-$RC/website -m "Remove staged website for ZooKeeper 3.8.0rc1" svn move https://dist.apache.org/repos/dist/dev/zookeeper/zookeeper-$RELEASE_VERSION-candidate-1 https://dist.apache.org/repos/dist/release/zookeeper/zookeeper-$RELEASE_VERSION -m "Release Apache ZooKeeper $RELEASE_VERSION" |
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.
svn co https://dist.apache.org/repos/dist/zookeeper/ zookeeper_dist 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. (install Jekyll/pygments if you haven't already - 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 _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:
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 |