Versions Compared

Key

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

...

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

    1. Answer to the VOTE email thread with a final RESULT email like this one:

    2. Code Block
      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


    3. Compare and sync the WORK_BRANCH with the RELEASE_BRANCH, check RELEASE NOTES and Maven Version in pom.xml and in the C client:
    4. Update the version in $BRANCH_NAME (like branch-3.6), the Maven Release plugin pushed it to the WORK_BRANCH, you should cherry pick it (actually they are 2 commits, one to remove SNAPSHOT and one to bump the version) but in case of conflict (if the branch diverged) you can do it with this command but you will have to manually update the C client files

      Code Block
      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


    5. Tag the release. Do it from the release branch and push the created tag to the remote repository, drop the $WORK_BRANCH:

      Code Block
      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


    6. Check in release files to the distribution server

    7. Code Block
      # 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_NUM/website -m "Remove staged website for ZooKeeper $RELEASE_VERSIONrc$RC_NUM"
      
      svn move https://dist.apache.org/repos/dist/dev/zookeeper/zookeeper-$RELEASE_VERSION-candidate-$RC_NUM https://dist.apache.org/repos/dist/release/zookeeper/zookeeper-$RELEASE_VERSION -m "Release Apache ZooKeeper $RELEASE_VERSION"
      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.
    8. 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
      svn co https://dist.apache.org/repos/dist/release/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'  


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

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

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


    12. 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 $ZKHOME/target/checkout/zookeeper-assembly/target/apache-zookeeper-X.Y.Z$RELEASE_VERSION-bin.tar.gz --strip-components 2 'apache-zookeeper-X.Y.Z$RELEASE_VERSION-bin/docs'
      rm apache-zookeeper-X.Y.Z$RELEASE_VERSION-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 ..


    13. Change directory to src/main/resources/markdown
    14. Update the release news in releases.md
    15. Update the nav panel in html/header.html and documentation.md to include X.Y.Z
    16. Stage changes to git

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


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


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

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


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

...