[arrow-adbc] branch main updated: docs: add RC verification instructions (#326)

[li...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git


The following commit(s) were added to refs/heads/main by this push:
     new 0280bd9  docs: add RC verification instructions (#326)
0280bd9 is described below

commit 0280bd95f08b4c238892f29c4cd189e7efa3e5de
Author: David Li <li...@gmail.com>
AuthorDate: Tue Jan 10 14:36:57 2023 -0500

    docs: add RC verification instructions (#326)
    
    Fixes #324.
    
    Co-authored-by: Benson Muite <bk...@users.noreply.github.com>
---
 docs/source/development/releasing.rst | 73 +++++++++++++++++++++++++++++++++++
 docs/source/index.rst                 |  2 +-
 2 files changed, 74 insertions(+), 1 deletion(-)

diff --git a/docs/source/development/releasing.rst b/docs/source/development/releasing.rst
index 7c9d6e1..dd0126b 100644
--- a/docs/source/development/releasing.rst
+++ b/docs/source/development/releasing.rst
@@ -185,6 +185,79 @@ Voting and approval
 Start the vote thread on dev@arrow.apache.org and supply instructions for verifying the integrity of the release.
 Approval requires a net of 3 +1 votes from PMC members. A release cannot be vetoed.
 
+How to Verify Release Candidates
+--------------------------------
+
+#. Install dependencies. If you are not using Conda (see below), you will need to install all dependencies to build and verify all languages. Either way, at minimum, you will need:
+
+   - cURL
+   - Docker (to verify binaries)
+   - Git
+   - GnuPG
+   - shasum (built into macOS) or sha256sum/sha512sum (on Linux)
+
+   If not using Conda, you will need roughly:
+
+   - C and C++ compilers (or the equivalent of ``build-essential`` for your platform)
+   - Python 3
+   - Ruby with headers
+   - bundler, rake, red-arrow, and test-unit Ruby gems
+   - GLib and gobject-introspection with headers
+   - Java JRE and JDK (Java 8+)
+   - Go
+   - CMake, ninja-build, libpq (with headers), SQLite (with headers)
+
+#. Download the source archive from dist.apache.org. A link to the source release is given in the vote email::
+
+     $ wget https://dist.apache.org/repos/dist/dev/arrow/apache-arrow-adbc-0.1.0-rc6/apache-arrow-adbc-0.1.0.tar.gz
+
+#. If you wish to verify the GPG signature and checksums well (the script will also verify these):
+
+   #. Download the signature and hash files::
+
+        $ wget https://dist.apache.org/repos/dist/dev/arrow/apache-arrow-adbc-0.1.0-rc6/apache-arrow-adbc-0.1.0.tar.gz.{asc,sha256,sha512}
+
+   #. Verify the signature::
+
+        $ gpg --verify apache-arrow-adbc-0.1.0.tar.gz.asc
+
+      You may have to import the maintainer keys first::
+
+        $ wget https://dist.apache.org/repos/dist/release/arrow/KEYS
+        $ gpg --import KEYS
+   #. Verify the checksums::
+
+        # For Linux
+        $ sha256sum -c apache-arrow-adbc-0.1.0.tar.gz.sha256
+        $ sha512sum -c apache-arrow-adbc-0.1.0.tar.gz.sha512
+
+        # For macOS
+        $ shashum -a 256 -c apache-arrow-adbc-0.1.0.tar.gz.sha256
+        $ shashum -a 512 -c apache-arrow-adbc-0.1.0.tar.gz.sha512
+
+#. Extract the archive::
+
+     $ tar xf apache-arrow-adbc-0.1.0.tar.gz
+#. Run the verification script::
+
+     $ cd apache-arrow-adbc-0.1.0-rc6
+     # Pass the version and the RC number
+     $ ./dev/release/verify-release-candidate.sh 0.1.0 6
+
+   You will have to install any system dependencies required
+   (e.g. CMake, libpq, Go, ...).  These environment variables may be helpful:
+
+   - ``ARROW_TMPDIR=path/to/directory`` to specify the temporary
+     directory used.  Using a fixed directory can help avoid repeating
+     the same setup and build steps if the script has to be run
+     multiple times.
+   - ``USE_CONDA=1`` to download and set up Conda for dependencies.
+     In this case, fewer dependencies are required from the system.
+     (Git, GnuPG, cURL, and some others are still required.)
+
+#. Once finished and once the script passes, reply to the mailing list
+   vote thread with a +1 or a -1.
+
 Post-release tasks
 ==================
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
index a0c558a..30539cc 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -65,7 +65,7 @@ Arrow-native database protocols.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Development:
+   :caption: Development
 
    development/contributing
    development/nightly