Merge pull request #8395 from poikilotherm/8394-maven-mods

8394 maven mods
IQSS · Mar 4, 2022 · 75414ea · 75414ea
2 parents f9f3394 + 09167d5
commit 75414ea
Show file tree

Hide file tree

Showing 11 changed files with 643 additions and 367 deletions.
diff --git a/.github/workflows/maven_unit_test.yml b/.github/workflows/maven_unit_test.yml
@@ -4,9 +4,13 @@ on:
     push:
         paths:
             - "**.java"
+            - "pom.xml"
+            - "modules/**/pom.xml"
     pull_request:
         paths:
             - "**.java"
+            - "pom.xml"
+            - "modules/**/pom.xml"
 
 jobs:
     unittest:

diff --git a/doc/sphinx-guides/source/developers/dependencies.rst b/doc/sphinx-guides/source/developers/dependencies.rst
diff --git a/doc/sphinx-guides/source/developers/intro.rst b/doc/sphinx-guides/source/developers/intro.rst
@@ -21,6 +21,8 @@ Getting Help
 
 If you have any questions at all, please reach out to other developers via the channels listed in https://github.com/IQSS/dataverse/blob/develop/CONTRIBUTING.md such as http://chat.dataverse.org, the `dataverse-dev <https://groups.google.com/forum/#!forum/dataverse-dev>`_ mailing list, `community calls <https://dataverse.org/community-calls>`_, or support@dataverse.org.
 
+.. _core-technologies:
+
 Core Technologies
 -----------------
 

diff --git a/doc/sphinx-guides/source/developers/making-releases.rst b/doc/sphinx-guides/source/developers/making-releases.rst
@@ -22,7 +22,7 @@ Make the following changes in the release branch:
 
 Increment the version number to the milestone (e.g. 4.6.2) in the following two files:
 
-- pom.xml
+- modules/dataverse-parent/pom.xml -> ``<properties>`` -> ``<revision>``
 - doc/sphinx-guides/source/conf.py (two places)
 
 Add the version being released to the lists in the following two files:
@@ -31,6 +31,7 @@ Add the version being released to the lists in the following two files:
 - scripts/database/releases.txt
 
 Here's an example commit where three of the four files above were updated at once: https://github.com/IQSS/dataverse/commit/99e23f96ec362ac2f524cb5cd80ca375fa13f196
+(Note: the version has been moved to a property in parent module since this commit was created.)
 
 2. Check in the Changes Above...
 ================================

diff --git a/doc/sphinx-guides/source/installation/advanced.rst b/doc/sphinx-guides/source/installation/advanced.rst
@@ -72,43 +72,44 @@ Once a standardized version of you Custom Terms are registered as a license, an
 Optional Components
 -------------------
 
+.. _zipdownloader:
+
 Standalone "Zipper" Service Tool
 ++++++++++++++++++++++++++++++++
 
-As of Dataverse Software 5.0 we offer an experimental optimization for the multi-file, download-as-zip functionality. If this option
-(``:CustomZipDownloadServiceUrl``) is enabled, instead of enforcing
-the size limit on multi-file zipped downloads (as normally specified
-by the option ``:ZipDownloadLimit``), we attempt to serve all the
-files that the user requested (that they are authorized to download),
-but the request is redirected to a standalone zipper service running
-as a cgi-bin executable under Apache. Thus moving these potentially
-long-running jobs completely outside the Application Server (Payara);
-and preventing worker threads from becoming locked serving them. Since
-zipping is also a CPU-intensive task, it is possible to have this
-service running on a different host system, freeing the cycles on the
-main Application Server. (The system running the service needs to have
-access to the database as well as to the storage filesystem, and/or S3
-bucket).
-
-Please consult the scripts/zipdownload/README.md in the Dataverse Software 5.0+ source tree for more information. 
-
-To install: You can follow the instructions in the file above to build
-``ZipDownloadService-v1.0.0.jar``. It will also be available, pre-built as part of the Dataverse Software 5.0 release on GitHub. Copy it, together with the shell
-script scripts/zipdownload/cgi-bin/zipdownload to the cgi-bin
-directory of the chosen Apache server (/var/www/cgi-bin standard). 
-
-Make sure the shell script (zipdownload) is executable, and edit it to configure the
-database access credentials. Do note that the executable does not need
-access to the entire Dataverse installation database. A security-conscious admin
-can create a dedicated database user with access to just one table:
-``CUSTOMZIPSERVICEREQUEST``.
-
-You may need to make extra Apache configuration changes to make sure /cgi-bin/zipdownload is accessible from the outside.
-For example, if this is the same Apache that's in front of your Dataverse installation Payara instance, you will need to add another pass through statement to your configuration:
+As of Dataverse Software 5.0 we offer an **experimental** optimization for the multi-file, download-as-zip functionality.
+If this option (``:CustomZipDownloadServiceUrl``) is enabled, instead of enforcing the size limit on multi-file zipped
+downloads (as normally specified by the option ``:ZipDownloadLimit``), we attempt to serve all the files that the user
+requested (that they are authorized to download), but the request is redirected to a standalone zipper service running
+as a cgi-bin executable under Apache. This moves these potentially long-running jobs completely outside the Application Server (Payara), and prevents worker threads from becoming locked serving them. Since zipping is also a CPU-intensive task, it is possible to have
+this service running on a different host system, freeing the cycles on the main Application Server. (The system running
+the service needs to have access to the database as well as to the storage filesystem, and/or S3 bucket).
+
+Please consult the `README at scripts/zipdownload <https://github.com/IQSS/dataverse/tree/master/scripts/zipdownload>`_
+in the Dataverse Software 5.0+ source tree for more information.
+
+To install:
+
+1. Follow the instructions in the file above to build ``zipdownloader-0.0.1.jar``. Please note that the package name and
+   the version were changed as of the release 5.10, as part of an overall cleanup and reorganization of the project 
+   tree. In the releases 5.0-5.9 it existed under the name ``ZipDownloadService-v1.0.0``. (A pre-built jar file was
+   distributed under that name as part of the 5.0 release on GitHub. Aside from the name change, there have been no 
+   changes in the functionality of the tool). 
+2. Copy it, together with the shell script :download:`cgi-bin/zipdownload <../../../../scripts/zipdownload/cgi-bin/zipdownload>`
+   to the ``cgi-bin`` directory of the chosen Apache server (``/var/www/cgi-bin`` standard).
+3. Make sure the shell script (``zipdownload``) is executable, and edit it to configure the database access credentials.
+   Do note that the executable does not need access to the entire Dataverse installation database. A security-conscious
+   admin can create a dedicated database user with access to just one table: ``CUSTOMZIPSERVICEREQUEST``.
+
+You may need to make extra Apache configuration changes to make sure ``/cgi-bin/zipdownload`` is accessible from the outside.
+For example, if this is the same Apache that's in front of your Dataverse installation Payara instance, you will need to
+add another pass through statement to your configuration:
 
 ``ProxyPassMatch ^/cgi-bin/zipdownload !``
 
-Test this by accessing it directly at ``<SERVER URL>/cgi-bin/download``. You should get a ``404 No such download job!``. If instead you are getting an "internal server error", this may be an SELinux issue; try ``setenforce Permissive``. If you are getting a generic Dataverse collection "not found" page, review the ``ProxyPassMatch`` rule you have added. 
+Test this by accessing it directly at ``<SERVER URL>/cgi-bin/download``. You should get a ``404 No such download job!``.
+If instead you are getting an "internal server error", this may be an SELinux issue; try ``setenforce Permissive``.
+If you are getting a generic Dataverse collection "not found" page, review the ``ProxyPassMatch`` rule you have added.
 
 To activate in your Dataverse installation::
 

diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst
@@ -2380,15 +2380,18 @@ If you don’t want date facets to be sorted chronologically, set:
 :CustomZipDownloadServiceUrl
 ++++++++++++++++++++++++++++
 
-The location of the "Standalone Zipper" service. If this option is specified, the Dataverse installation will be redirecing bulk/mutli-file zip download requests to that location, instead of serving them internally. See the "Advanced" section of the Installation guide for information on how to install the external zipper. (This is still an experimental feature, as of Dataverse Software 5.0).
+The location of the "Standalone Zipper" service. If this option is specified, the Dataverse installation will be
+redirecing bulk/multi-file zip download requests to that location, instead of serving them internally.
+See :ref:`zipdownloader` of the Advanced Installation guide for information on how to install the external zipper.
+(This is still an **experimental** feature, as of Dataverse Software 5.0).
 
 To enable redirects to the zipper installed on the same server as the main Dataverse Software application: 
 
 ``curl -X PUT -d '/cgi-bin/zipdownload' http://localhost:8080/api/admin/settings/:CustomZipDownloadServiceUrl``
 
 To enable redirects to the zipper on a different server: 
 
-``curl -X PUT -d 'https://zipper.example.edu/cgi-bin/zipdownload' http://localhost:8080/api/admin/settings/:CustomZipDownloadServiceUrl`` 
+``curl -X PUT -d 'https://zipper.example.edu/cgi-bin/zipdownload' http://localhost:8080/api/admin/settings/:CustomZipDownloadServiceUrl``
 
 :ArchiverClassName
 ++++++++++++++++++