You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

This document is still WORK-IN-PROGRESS by Enrico Olivelli please ask on dev@zookeeper.apache.org for info.


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:

  1. 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.
  2. Now you need to register your key at http://pgp.mit.edu/ using the output of gpg --armor --export <keyid>
  3. 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
  4. Upload digest to your account on id.apache.org (gpg2 --fingerprint)

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.

Please follow the instructions here to encrypt your Apache credentials: https://maven.apache.org/guides/mini/guide-encryption.html

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

Smoke Tests

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

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

Checkout a fresh new clone

Check out a fresh new copy of the repository:

git clone https://gitbox.apache.org/repos/asf/zookeeper.git
cd zookeeper

Test your docker environment

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:

  • Linux
  • Java 8
  • Maven
  • OpenSSL

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




Create a branch (for major release, say 3.6.0)

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

RC_NUM=0
BRANCH_NAME=branch-3.6
BRANCH_VERSION=3.6.0-SNAPSHOT
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:

  • change the version in master branch
  • create a new release branch

Prepare release branch (for minor release, say 3.6.1)

RC_NUM=0
BRANCH_NAME=branch-3.6
BRANCH_VERSION=3.6.1-SNAPSHOT
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


Create release notes on release 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 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

Push the change to the release branch (no review is needed at this point)

Build and check that the release branch is in good shape

Run spotBugs, checkstyle and rat checks:

git clean -xdf
# perform quality checks
mvn clean apache-rat:check -DskipTests -Pfull-build
mvn clean install checkstyle:check spotbugs:check -DskipTests -Pfull-build
# run tests
mvn clean install -Pfull-build

Perform a release on branch (for major and minor release)

git checkout $BRANCH_NAME
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  Unable to render Jira issues macro, execution error.

The command above perform the following activities:

  • removes -SNAPSHOT in all of the pom.xml files (the version is RELEASE_VERSION)
  • build the project (even the C client and contrib packages)
  • ensures the correct version in C client files (configure.ac, CMakelink.txt, TODO zookeeper_version.h)
  • created a signed tag
  • bump the branch to the next minor version (RELEASE_DEVELOPMENT_VERSION)

Checklist

  • 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
  • In Jira, move open issues to next version. Disable mail notifications for this bulk change.

Preparing the release candidate

  • 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

    git checkout $TAG
git clean -xdf 
mvn release:perform -Darguments='-DskipTests=true -Pfull-build,apache-release' -Papache-release,full-build
  • You should have the SIGNED jar files and also the tarballs built. The two tarball is available at:
    • zookeeper-assembly/target/apache-zookeeper-X.Y.Z-bin.tar.gz
    • zookeeper-assembly/target/apache-zookeeper-X.Y.Z.tar.gz
  • This command also staged all of the maven artifacts to repository.apache.org

Self validate the Release candidate

Check that release file looks ok - e.g. install it and run examples from tutorial.

  • untar the release artifact in a test directory
  • try to build the sources with
mvn clean install -DskipTests -Pfull-build
  • validate the contents of the staging Maven repository

Stage source and binaries to your own Apache home

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

Close the Maven Repository

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

Publishing (TODO)


    1. 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
    2. Check in release files to the distribution server
    3. 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"
      1. 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.

    4. 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'
    5. 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.

    6. Wait 24 hours for release to propagate to mirrors.

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

    8. 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 ..
    9. Change directory to src/main/resources/markdown
    10. Update the release news in releases.md
    11. Update the nav panel in html/header.html and documentation.md to include X.Y.Z

    12. Stage changes to git

      git add releases.md documentation.md html/header.html

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

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

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