Skip to content

MINOR: create a checklist for testing a new Storm release #3161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ethanlm merged 2 commits into from
Oct 31, 2019
Merged

MINOR: create a checklist for testing a new Storm release #3161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b01bc8e
MINOR: create a checklist for testing a new Storm release
Ethanlm Oct 30, 2019
595c55d
MINOR: add link to dev-tools/rc and remove MD5 file check
Ethanlm Oct 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Committer documentation
# Release

This document summarizes information relevant to Storm committers. It includes information about
the Storm release process.
This document includes information about the Storm release process.

---

Expand Down Expand Up @@ -85,3 +84,24 @@ gpg --print-md SHA512 RELEASE_NOTES.html > RELEASE_NOTES.html.sha512
2. Delete the staged distribution files from https://dist.apache.org/repos/dist/dev/storm/

3. Delete the git tag.

# How to vote on a release candidate
Copy link
Copy Markdown
Contributor

@srdo srdo Oct 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if this belongs at the top of the file? The audience for it is probably broader than the audience for how to author a release.

Copy link
Copy Markdown
Contributor Author

@Ethanlm Ethanlm Oct 31, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make sense


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.

1. Verify files such as *.asc, *.sha512; some scripts are available under `dev-tools/rc` to help with it;
2. Build Apache Storm source code and run unit tests, create an Apache Storm distribution;
3. Set up a standalone cluster using apache-storm-xxx.zip, apache-storm-xxx.tar.gz, the Apache Storm distribution created from step 2, separately;
4. Launch WordCountTopology and ThroughputVsLatency topology and check logs, UI metrics, etc;
5. Test basic UI functionalities such as jstack, heap dump, deactivate, activate, rebalance, change log level, log search, kill topology;
6. Test basic CLI such as kill, list, deactivate, deactivate, rebalance, etc.

It's also preferable to set up a standalone secure Apache Storm cluster and test basic funcionalities 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.
15 changes: 0 additions & 15 deletions dev-tools/rc/verify-release-file.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,6 @@ else
echo 'Signature seems not correct'
fi

# checking MD5
GPG_MD5_FILE="/tmp/${TARGET_FILE}_GPG.md5"
gpg --print-md MD5 ${TARGET_FILE} > ${GPG_MD5_FILE}
MD5_TARGET_FILE="${TARGET_FILE}.md5"

echo ">> checking MD5 file... (${MD5_TARGET_FILE})"
diff ${GPG_MD5_FILE} ${MD5_TARGET_FILE}

if [ $? -eq 0 ];
then
echo 'MD5 file is correct'
else
echo 'MD5 file is not correct'
fi

# checking SHA
GPG_SHA_FILE="/tmp/${TARGET_FILE}_GPG.sha512"
gpg --print-md SHA512 ${TARGET_FILE} > ${GPG_SHA_FILE}
Expand Down