Skip to content

Commit 1552293

Browse files
authored
apacheGH-40833: [Docs][Release] Make explicit in the documentation that verifying binaries is not required in order to case a vote (apache#40834)
### Rationale for this change Based on the discussion on https://lists.apache.org/thread/ogp9dthp124oq0fmvlyzvjorjsyom03v making clear that binaries verification are not required in order to cast a positive vote for the release. ### What changes are included in this PR? Document the required process ### Are these changes tested? preview-docs job on archery will be run ### Are there any user-facing changes? No * GitHub Issue: apache#40833 Authored-by: Raúl Cumplido <[email protected]> Signed-off-by: Raúl Cumplido <[email protected]>
1 parent 42b49df commit 1552293

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

docs/source/developers/release_verification.rst

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,36 @@ Linux and macOS
4444
In order to run the verification script either for the source release or the
4545
binary artifacts see the following guidelines:
4646

47+
Required source verification
48+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49+
50+
Individuals are REQUIRED to download all signed source code packages onto their
51+
own hardware, validate all cryptographic signatures, compile as provided,
52+
and test the result on their own platform in order to cast a +1 vote.
53+
4754
.. code-block::
4855
4956
# this will create and automatically clean up a temporary directory for the verification environment and will run the source verification
5057
TEST_DEFAULT=0 TEST_SOURCE=1 verify-release-candidate.sh $VERSION $RC_NUM
5158
52-
# this will create and automatically clean up a temporary directory for the verification environment and will run the binary verification
53-
TEST_DEFAULT=0 TEST_BINARIES=1 dev/release/verify-release-candidate.sh $VERSION $RC_NUM
54-
5559
# to verify only certain implementations use the TEST_DEFAULT=0 and TEST_* variables
5660
# here are a couple of examples, but see the source code for the available options
5761
TEST_DEFAULT=0 TEST_CPP=1 verify-release-candidate.sh $VERSION $RC_NUM # only C++ tests
5862
TEST_DEFAULT=0 TEST_CPP=1 TEST_PYTHON=1 verify-release-candidate.sh $VERSION $RC_NUM # C++ and Python tests
5963
TEST_DEFAULT=0 TEST_INTEGRATION_CPP=1 TEST_INTEGRATION_JAVA=1 verify-release-candidate.sh $VERSION $RC_NUM # C++ and Java integration tests
60-
64+
65+
Binary verification
66+
^^^^^^^^^^^^^^^^^^^
67+
68+
The binaries are generated from the source that has been verified. Those binaries are
69+
tested on CI but can be tested locally for further validation. It is not necessary to
70+
test them in order to cast a positive vote.
71+
72+
.. code-block::
73+
74+
# this will create and automatically clean up a temporary directory for the verification environment and will run the binary verification
75+
TEST_DEFAULT=0 TEST_BINARIES=1 dev/release/verify-release-candidate.sh $VERSION $RC_NUM
76+
6177
# to verify certain binaries use the TEST_* variables as:
6278
TEST_DEFAULT=0 TEST_WHEELS=1 verify-release-candidate.sh $VERSION $RC_NUM # only Wheels
6379
TEST_DEFAULT=0 TEST_APT=1 verify-release-candidate.sh $VERSION $RC_NUM # only APT packages
@@ -130,7 +146,6 @@ As an example:
130146
I've verified successfully the sources and binaries with:
131147
132148
TEST_DEFAULT=0 TEST_SOURCE=1 dev/release/verify-release-candidate.sh 15.0.0 1
133-
TEST_DEFAULT=0 TEST_BINARIES=1 dev/release/verify-release-candidate.sh 15.0.0 1
134149
with:
135150
* Python 3.10.12
136151
* gcc (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0

0 commit comments

Comments
 (0)