Skip to content

Commit 863b7b9

Browse files
TAK LON WUbusbey
authored andcommitted
HBASE-22395 Document RC voting guidelines in ref guide
closes #297 Signed-off-by: Sean Busbey <[email protected]>
1 parent 04a91f9 commit 863b7b9

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

src/main/asciidoc/_chapters/developer.adoc

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1004,7 +1004,18 @@ Regards the latter, run `mvn apache-rat:check` to verify all files are suitably
10041004
See link:http://search-hadoop.com/m/DHED4dhFaU[HBase, mail # dev - On recent discussion clarifying ASF release policy]
10051005
for how we arrived at this process.
10061006

1007-
To help with the release verfication `hbase-vote.sh` shell script is available under `dev-support` directory of HBase source. Following are the usage details.
1007+
To help with the release verification, please follow the guideline below and vote based on the your verification.
1008+
1009+
=== Baseline Verifications for Voting Release Candidates
1010+
1011+
Although contributors have their own checklist for verifications, the following items are usually used for voting on release candidates.
1012+
1013+
* CHANGES.md if any
1014+
* RELEASENOTES.md (release notes) if any
1015+
* Generated API compatibility report
1016+
** For what should be compatible please refer the link:https://hbase.apache.org/book.html#hbase.versioning[versioning guideline], especially for items with marked as high severity
1017+
* Use `hbase-vote.sh` to perform sanity checks for checksum, signatures, files are licensed, built from source, and unit tests.
1018+
** `hbase-vote.sh` shell script is available under `dev-support` directory of HBase source. Following are the usage details.
10081019

10091020
[source,bourne]
10101021
----
@@ -1027,6 +1038,15 @@ Usage: hbase-vote.sh -s | --source <url> [-k | --key <signature>] [-f | --keys-f
10271038
http://www.apache.org/dist/hbase/KEYS
10281039
-o | --output-dir '</path>' directory which has the stdout and stderr of each verification target
10291040
----
1041+
* If you see any unit test failures, please call out the solo test result and whether it's part of flaky (nightly) tests dashboard, e.g. link:https://builds.apache.org/view/H-L/view/HBase/job/HBase-Find-Flaky-Tests/job/master/lastSuccessfulBuild/artifact/dashboard.html[dashboard of master branch] (please change the test branch accordingly).
1042+
1043+
=== Additional Verifications for Voting Release Candidates
1044+
1045+
Other than the common verifications, contributors may call out additional concerns, e.g. for a specific feature by running end to end tests on a distributed environment. This is optional and always encouraged.
1046+
1047+
* Start a distributed HBase cluster and call out the test result of specific workload on cluster. e.g.
1048+
** Run basic table operations, e.g. `create/put/get/scan/flush/list/disable/drop`
1049+
** Run built-in tests, e.g. `LoadTestTool` (LTT) and `IntegrationTestBigLinkedList` (ITBLL)
10301050

10311051
[[hbase.release.announcement]]
10321052
== Announcing Releases

0 commit comments

Comments
 (0)