Versions Compared

Old Version 26

changes.mady.by.user Enrico Olivelli

Saved on

compared with

New Version 27

changes.mady.by.user Enrico Olivelli

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
# Staged artifacts built by "release:perform" are in target/checkout

cd target/checkout/zookeeper-assembly/target

sftp home.apache.org
> cd public_html
> mkdir zookeeper-$VERSION-candidate-0
> cd zookeeper-$VERSION-candidate-0
> put *-bin.tar.gz
> put *-bin.tar.gz.asc
> put *-bin.tar.gz.sha512
> put *-liblcd ../../target

# pwd should be target/checkout/target
> put apache-zookkeper-$VERSION-source-release.tar.gz
> put *-libapache-zookkeper-$VERSION-source-release.tar.gz.asc
> put *-libapache-zookkeper-$VERSION-source-release.tar.gz.sha512
> bye

cdlcd ../zookeeper-docs/target/html
#> pwd should be target/checkout/target
cp parent-$VERSION-SNAPSHOT-source-release.zip apache-zookeeper-$VERSION.zip
cp parent-$VERSION-SNAPSHOT-source-release.zip.asc apache-zookeeper-$VERSION.zip.asc
cp parent-$VERSION-SNAPSHOT-source-release.zip.sha512 apache-zookeeper-$VERSION.zip.sha512
sftp home.apache.org
> cd public_html
> cd zookeeper-$VERSION-candidate-0
> put apache-zookkeper-$VERSION.zip
> put apache-zookkeper-$VERSION.zip.asc
> put apache-zookkeper-$VERSION.zip.sha512
> bye

cd ../zookeeper-docs/target/site/html
sftp home.apache.org
> cd public_html
> cd zookeeper-$VERSION-candidate-0
> upload website...

Call for VOTE

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

Subject: [VOTE] Apache ZooKeeper release 3.6.0 candidate 0
 

This is a release candidate for 3.6.0.

upload website...


Call for VOTE

Cancelling a Release Candidate

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

It is a major release and it introduces a lot of new features, most notably:
- Built-in data consistency check inside ZooKeeper
- Allow Followers to host Observers
- A new feature proposal to ZooKeeper: authentication enforcement
- Pluggable metrics system for ZooKeeper (and Prometheus.io integration)
- TLS Port unification
- Audit logging in ZooKeeper servers
- Improve resilience to network (advertise multiple addresses for members of a Zookeeper cluster)
- Persistent Recursive Watch
- add an API and the corresponding CLI to get total count of recursive sub nodes under a specific path
 
The full release notes is available at:
 
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310801&version=12346617
 
*** Please download, test and vote by January 19th 2020, 23:59 UTC+0. ***
 
Source files:
https://people.apache.org/~eolivelli/zookeeper-3.6.0-candidate-0/
 
Maven staging repo:
https://repository.apache.org/content/repositories/orgapachezookeeper-1045/
 
The release candidate tag in git to be voted upon: release-3.6.0-0
https://github.com/apache/zookeeper/tree/release-3.6.0-0
 
ZooKeeper's KEYS file containing PGP keys we use to sign the release:
https://www.apache.org/dist/zookeeper/KEYS

Please note that this new major release introduces these change in the staging area:
- the source artifacts package is in zip format
- we are releasing a new binary package with the C client (with OpenSSL support)
- website preview
We are also adding a new JAR: zookeeper-metrics-providers
The staging version of the website is:
https://people.apache.org/~eolivelli/zookeeper-3.6.0-candidate-0/website/

Should we release this candidate?

...

Publishing (TODO)

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

    1. Compare and sync the WORK_BRANCH with the RELEASE_BRANCH, check RELEASE NOTES and Maven Version in pom.xml and in the C client

    2. Tag the release. Do it from the release branch and push the created tag to the remote repository:

      Code Block
      git checkout $WORK_BRANCH
# 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


    3. Check in release files to the distribution server


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

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


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

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

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


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


    10. Change directory to src/main/resources/markdown
    11. Update the release news in releases.md
    12. Update the nav panel in html/header.html and documentation.md to include X.Y.Z

    13. Stage changes to git

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


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


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

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


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