...
Code Block | ||||
---|---|---|---|---|
| ||||
<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> <server> <id>apache.releases.https</id> <username>YOUR_APACHE_ID</username> <password>YOUR_APACHE_PASSWORD</password> </server> </servers> <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> |
...
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 VERSION=X.Y.Z NEWVERSION=X.Y.(Z+1) BRANCH_NAME=branch-$VERSION REMOTE=origin git branch $BRANCH_NAME git push $REMOTE $BRANCH_NAME
Update to next SNAPSHOT version
Code Block language xml mvn clean org.codehaus.mojo:versions-maven-plugin:2.7:set -DgenerateBackupPoms=false -DnewVersion=$NEWVERSION-SNAPSHOT
Also update the version number 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 to the next logical SNAPSHOT version (e.g. X.Y.Z to X.Y.(Z+1)-SNAPSHOT)Code Block cd zookeeper-client/zookeeper-client-c sed -i s/$VERSION/$NEWVERSION/g configure.ac sed -i s/$VERSION/$NEWVERSION/g CMakeLists.txt cd ../.. grep -r $NEWVERSION *
- 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.
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 "Prepare for the next release: update the version to X.Y.(Z+1)-SNAPSHOT" git push <remote> branch-X.Y.Z
Checkout the active point release branch - this is where you will be creating the release candidate
Code Block git checkout branch-X.Y.Z
If not already done, cherry-pick desired commits into branch-X.Y.Z. If cherry-picks are done from other than branch-X.Y ensure that those changes are also committed to branch-X.Y. If there are conflicts, then it is preferable to produce a new patch for this branch, review it separately and commit it via JIRA. Please refer HowToContribute and Committing changes page for pushing changes to the project.
Code Block # The -x option records the source commit, and reuses the original commit message git cherry-pick -x <commit-hash>
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:Code Block language xml :%s/<\/h2>//gc :%s/<li>\[<a href='\(.*\)'>\(ZOOKEEPER-[0-9]\+\)<\/a>\] - \+/* [\2](\1) - /gc :%s/<\/li>\n//gc
Update versions in pom.xml (remove SNAPSHOT):
Code Block language xml mvn clean org.codehaus.mojo:versions-maven-plugin:2.7:set -DgenerateBackupPoms=false -DnewVersion=$VERSION
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
- Update the version number in build.xml to be ''X.Y.Z'' (i.e. remove SNAPSHOT designator)
- Update the copyright years in NOTICE.txt if it's outdated.
Commit these changes.
Code Block language xml # 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:
Code Block git clean -xdf mvn clean apache-rat:check -DskipTests -Pfull-build mvn clean install checkstyle:check spotbugs:check -DskipTests -Pfull-build
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
If you have issues signing the tag, refer to this gist.
- In Jira, move open issues to next version. Disable mail notifications for this bulk change.
...
Tag the release. Do it from the release branch and push the created tag to the remote repository:
Code Block # 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
- Check in release files to the distribution server
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" --username <your apache user ID>
- 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.
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'
- Release the Maven artifacts on Apache Nexus:
- Click on 'Staging repositories'.
- Select the repository corresponding to the release candidate.
- Click on the 'Release' button and follow instructions.
- Wait 24 hours for release to propagate to mirrors.
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
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 ..
- Change directory to src/main/resources/markdown
- Update the release news in releases.md
- Update the nav panel in html/header.html and documentation.md to include X.Y.Z
Stage changes to git
Code Block 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 - for possible prerequisites, 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 _sitetarget/html/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:
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
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
- In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
- 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.
- In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.
Smoke Tests
Before the release, run the following smoke tests (at least).
- Run unit tests on different hardwares: mac, windows, linux.