This document includes information about the Storm release process.
Apache Storm follows the basic idea of Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
${user.home}/.m2/settings.xml:<settings> ... <servers> <!-- To publish a snapshot of your project --> <server> <id>apache.snapshots.https</id> <username> <!-- YOUR APACHE LDAP USERNAME --> </username> <password> <!-- YOUR APACHE LDAP PASSWORD (encrypted) --> </password> </server> <!-- To stage a release of your project --> <server> <id>apache.releases.https</id> <username> <!-- YOUR APACHE LDAP USERNAME --> </username> <password> <!-- YOUR APACHE LDAP PASSWORD (encrypted) --> </password> </server> ... </servers> </settings>
svn checkout https://dist.apache.org/repos/dist/release/storm/ gpg --export --armor <YOUR_KEY_ID> >> storm/KEYS svn commit storm/KEYS -m "Add GPG key for release manager <YOUR NAME>"
/var/run/docker.sock has the correct permissions, otherwise you might see the error Could not find a valid Docker environment)If you are setting up a new MINOR version release, create a new branch based on master branch, e.g. 2.7.x-branch. Then on master branch, set the version to a higher MINOR version (with SNAPSHOT), e.g. mvn versions:set -DnewVersion=2.8.0-SNAPSHOT -P dist,rat,externals,examples. In this way, you create a new release line and then you can create PATCH version releases from it, e.g. 2.7.1.
Checkout to the branch to be released.
Run mvn release:prepare -P dist,rat,externals,examples followed by mvn release:perform -P dist,rat,externals,examples. This will create all the artifacts that will eventually be available in maven central. This step may seem simple, but a lot can go wrong (mainly flaky tests). Note that this will create and push two commits with the commit message starting with “[maven-release-plugin]” and it will also create and publish a git tag, e.g. v2.8.1. Note: the full build can take up to 30 minutes to complete.
If the build fails mid-way, run mvn release:clean to remove generated files before retrying.
Once you get a successful maven release, a “staging repository” will be created at https://repository.apache.org in the “open” state, meaning it is still writable. You will need to close it, making it read-only. You can find more information on this step here.
Note the staging repository ID (e.g. orgapachestorm-1234) shown in the Maven console output, or find it in the Nexus UI under Staging Repositories at https://repository.apache.org/#stagingRepositories. You will need this ID in the vote email template.
Checkout to the git tag that was published by Step 2 above, e.g. git checkout tags/v2.8.1 -b v2.8.1. Then build and package the distributions:
mvn clean install -DskipTests -P dist cd storm-dist/binary && mvn package && cd ../.. cd storm-dist/source && mvn package && cd ../..
Generate checksums for the *.tar.gz and *.zip distribution files, e.g.
macOS note: use
shasum -a 512in place ofsha512sum.
The Maven build may already have generated
.sha512files in the target directories; verify they exist before running the commands below.
pushd storm-dist/source/target sha512sum apache-storm-2.8.1-src.zip > apache-storm-2.8.1-src.zip.sha512 sha512sum apache-storm-2.8.1-src.tar.gz > apache-storm-2.8.1-src.tar.gz.sha512 popd pushd storm-dist/binary/final-package/target sha512sum apache-storm-2.8.1.zip > apache-storm-2.8.1.zip.sha512 sha512sum apache-storm-2.8.1.tar.gz > apache-storm-2.8.1.tar.gz.sha512 popd
Create a directory in the dist svn repo for the release candidate: https://dist.apache.org/repos/dist/dev/storm/apache-storm-x.x.x-rcx
Before generating the release notes, please double check if all merged pull requests for the version being released are assigned the milestone in question. They won't be placed in the release notes otherwise.
Run dev-tools/release_notes.py for the release version, piping the output to a RELEASE_NOTES.html file. Move that file to the svn release directory, sign it, and generate checksums, e.g.
export GITHUB_TOKEN=<your-github-pat> python3 dev-tools/release_notes.py <id-of-the-github-milestone> > RELEASE_NOTES.html gpg --armor --output RELEASE_NOTES.html.asc --detach-sig RELEASE_NOTES.html sha512sum RELEASE_NOTES.html > RELEASE_NOTES.html.sha512
To create a personal access token:
public_repo scope.To obtain the ID of a GitHub milestone:
https://github.com/apache/storm/milestone/40, where the last number is the milestone ID.Move the release files from steps 4, 5 and 8 to the svn directory from Step 6. Example of the set of files:
apache-storm-2.8.3-src.tar.gz apache-storm-2.8.3-src.zip apache-storm-2.8.3.tar.gz apache-storm-2.8.3.zip RELEASE_NOTES.html apache-storm-2.8.3-src.tar.gz.asc apache-storm-2.8.3-src.zip.asc apache-storm-2.8.3.tar.gz.asc apache-storm-2.8.3.zip.asc RELEASE_NOTES.html.asc apache-storm-2.8.3-src.tar.gz.sha512 apache-storm-2.8.3-src.zip.sha512 apache-storm-2.8.3.tar.gz.sha512 apache-storm-2.8.3.zip.sha512 RELEASE_NOTES.html.sha512
Add and commit the files to SVN. This makes them available in the Apache staging repo.
cd <your-svn-checkout>/apache-storm-x.x.x-rcx svn add * svn commit -m "Add release candidate apache-storm-x.x.x-rcx"
Start the VOTE thread. The vote should follow the ASF voting process.
Sample template, sent to dev@storm.apache.org:
Subject: [VOTE] Release Apache Storm [VERSION] (rcN)
Hi folks,
I have posted a [Nth] release candidate for the Apache Storm [VERSION] release and it is ready for testing.
The Nexus staging repository is here:
https://repository.apache.org/content/repositories/orgapachestorm-[REPO_NUM]
Storm Source and Binary Release with sha512 signature files are here:
https://dist.apache.org/repos/dist/dev/storm/apache-storm-[VERSION]-rcN/
The release artifacts are signed with the following key:
https://keyserver.ubuntu.com/pks/lookup?op=index&fingerprint=on&search=[KEY]
in this file https://downloads.apache.org/storm/KEYS
The release was made from the Apache Storm [VERSION] tag at:
https://github.com/apache/storm/tree/v[VERSION]
Full list of changes in this release:
https://dist.apache.org/repos/dist/dev/storm/apache-storm-[VERSION]-rcN/RELEASE_NOTES.html
To use it in a maven build set the version for Storm to [VERSION] and add the following URL to your settings.xml file:
https://repository.apache.org/content/repositories/orgapachestorm-[REPO_NUM]
The release was made using the Storm release process, documented on the GitHub repository:
https://github.com/apache/storm/blob/master/RELEASING.md
Please vote on releasing these packages as Apache Storm [VERSION]. The vote is open for at least the next 72 hours.
"How to vote" is described here: https://github.com/apache/storm/blob/master/RELEASING.md#how-to-vote-on-a-release-candidate
When voting, please list the actions taken to verify the release.
Only votes from the Storm PMC are binding, but everyone is welcome to check the release candidate and vote.
The vote passes if at least three binding +1 votes are cast.
[ ] +1 Release this package as Apache Storm [VERSION]
[ ] 0 No opinion
[ ] -1 Do not release this package because...
Thanks to everyone who contributed to this release.
Thanks!
[Release Manager Name]
Announce the results. Use the following template:
Subject: [VOTE][RESULT] Storm [VERSION] Release Candidate [N] Dear Community, The voting for releasing Apache Storm [VERSION] Release Candidate [N] has passed with # +1 votes (# binding) and # +0 or -1 votes. +1 votes: * ###### / binding * ############ Vote thread can be found at: https://lists.apache.org/thread.html/############## Thanks everyone for taking the time to review and vote for the release! We will continue the rest of release process and send out the announcement email in the coming days. Thanks to everyone who contributed to this release. [RELEASE MANAGER NAME]
Move the release candidate to the release directory and publish it:
svn mv https://dist.apache.org/repos/dist/dev/storm/apache-storm-x.x.x-rcx \ https://dist.apache.org/repos/dist/release/storm/apache-storm-x.x.x \ -m "Publish Apache Storm x.x.x release"
This will make the release artifacts available on dist.apache.org and the artifacts will start replicating to mirrors.
Go to https://repository.apache.org and release the staging repository.
Wait at least 24 hrs. for the mirrors to catch up.
Check out the storm-site repository, and follow the README to generate release specific documentation for the site. Compose a new blog post announcement for the new release. Update the downloads page. Finally, commit and push the site as described in the storm-site README to publish the site.
Update doap_Storm.rdf with the new release version.
Announce the new release to dev@storm.apache.org, user@storm.apache.org, and announce@apache.org. You will need to use your @apache.org email to do this.
Delete any outdated releases from the https://dist.apache.org/repos/dist/release/storm/ repository. See when to archive.
Delete any outdated releases from the storm-site releases directory, and republish the site.
Create a release on GitHub. Generate the release notes with the GitHub tooling.
Create a new release for Storm Docker. Example of a version release here. After that is done, a PR to docker-library must be submitted, so that the new docker-storm version is officially released. Example of such a PR is here.
Post, promote, celebrate. ;) Announcement email can be sent to announce@apache.org using the following template:
Subject: [ANNOUNCE] Apache Storm [VERSION] Released The Apache Storm community is pleased to announce the release of Apache Storm version [VERSION]. Apache Storm is a distributed, fault-tolerant, and high-performance realtime computation system that provides strong guarantees on the processing of data. You can read more about Apache Storm on the project website: https://storm.apache.org/ Downloads of source and binary distributions are listed in our download section: https://storm.apache.org/downloads.html You can read more about this release in the following blog post: https://storm.apache.org/[YEAR]/[MONTH]/[DAY]/storm[VERSION]-released.html Distribution artifacts are available in Maven Central at the following coordinates: groupId: org.apache.storm artifactId: storm-{component} version: [VERSION] The full list of changes is available here [1]. Please let us know [2] if you encounter any problems. Regards, The Apache Storm Team [1] https://downloads.apache.org/storm/apache-storm-[VERSION]/RELEASE_NOTES.html [2] https://github.com/apache/storm/issues
Go to https://repository.apache.org and drop the staging repository.
Delete the staged distribution files from https://dist.apache.org/repos/dist/dev/storm/.
Delete the git tag.
Send a [VOTE][CANCELED] message to dev@storm.apache.org using the following format:
Subject: [VOTE][CANCELED] Storm [VERSION] Release Candidate [N] This release candidate Storm Release candidate [VERSION] rcN https://dist.apache.org/repos/dist/dev/storm/apache-storm-[VERSION]-rcN/ has been canceled. New vote request will be sent out on RC[N+1] with further updates. [RELEASE MANAGER NAME]
We encourage everyone to review and vote on a release candidate to make an Apache Storm release more reliable and trustworthy.
Below is a checklist that one could do to review a release candidate. Please note this list is not exhaustive and only includes some of the common steps. Feel free to add your own tests.
dev-tools/rc to help with it;It's also preferable to set up a standalone secure Apache Storm cluster and test basic functionalities on it.
Don't feel the pressure to do everything listed above. After you finish your review, reply to the corresponding email thread with your vote, summarize the work you have performed and elaborate the issues you have found if any. Also please feel free to update the checklist if you think anything important is missing there.
Your contribution is very much appreciated.