Versions Compared

Key

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

...

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.

Branching and Tagging

  • Check out the branch you are making the release of:

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

    Code Block
    git branch branch-X.Y.Z
    git push <remote> branch-X.Y.Z


  • Remove the "-SNAPSHOT" from the version in all pom.xml.
    For example, to do the first release candidate on 3.5.5, run:

    Code Block
    languagexml
    title.m2 settings
    mvn clean org.codehaus.mojo:versions-maven-plugin:2.7:set -DnewVersion=3.5.5

    Note: we do not add "-RC0" at the and, because if votes passes on the Release Candidate, this will be the release we deploy to maven central.

    Also update the version number in src/c/configure.acsrc/c/CMakeLists.txt, and src/c/include/zookeeper_version.h to the next logical SNAPSHOT version (e.g. X.Y.Z to X.Y.(Z+1)-SNAPSHOT)

  • Update the copyright years in NOTICE.txt if it's outdated.
  • Do a search in the project for the version with the attached -SNAPSHOT to make sure it is changed everywhere. Some files (other than pom.xml) might also contain a hard coded version.

  • Clean your working directory:

    Code Block
    languagexml
    mvn clean
    git clean -fxd


  • ToDO: rat here?

  • Commit these changes.

    Code Block
    # 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 "Preparing for release X.Y.Z"
    git push <remote> branch-X.Y.Z


  • Tag the release candidate (R is the release candidate number, and starts from 0):

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


...

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

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

    Code Block
    mvn deploy -DskipTests -Papache-release
    


  • Make the release candidate available

    You can check the artifacts you just uploaded in the Apache’s Nexus at repository.apache.org using your Apache ID. Click 'Staging Repositories' and look for a new ZooKeeper repository with a status of 'Open'. Check that all the artifacts and pom files are available. As long as this is in open state, you can re-upload your files. Or just use 'Drop' on the staging repo.

    If it checks out, close the repo using the 'Close' button. The repository must be closed before a public URL to it becomes available. It may take a few minutes for the repository to close. Once complete you’ll see a public URL to the repository in the Nexus UI. You may also receive an email with the URL. Provide the URL to the temporary staging repository in the email that announces the release candidate.

    When the release vote concludes successfully, return here and click the 'Release' button to release the artifacts to central. The release process will automatically drop and delete the staging repository.

Smoke Tests

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

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

    .



***************

***************

...