From: Galen Charlton <gmc@equinoxOLI.org>
Date: Wed, 3 May 2023 14:35:28 +0000 (-0400)
Subject: LP#1901932: (follow-up) update help in make_release
X-Git-Url: http://git.equinoxoli.org/?p=evergreen-equinox.git;a=commitdiff_plain;h=8f0aeae4f97f9853598fe0b36826c75bf11f47b6

LP#1901932: (follow-up) update help in make_release

This patch clarifies the usage of make_release during
updates of Enhanced Concerto and makes it clear that
such updates are considered experimental for now.

Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>
---

diff --git a/build/tools/make_release b/build/tools/make_release
index 9d1ae88..3443397 100755
--- a/build/tools/make_release
+++ b/build/tools/make_release
@@ -92,8 +92,6 @@ while getopts ":hv:f:F:nptbrij:cxH:D:U:P:O:" opt; do
             echo "   VERSION is auto-detected by default and is based on the currently checked out branch."
             echo "   PREV_BRANCH is auto-detected by default but that isn't reliable. Include remote name!"
             echo "   PREV_VERSION Is auto-detected by default and is based on the PREV_BRANCH's name."
-            echo "   Postgres credentials are required if you want to upgrade the enhanced concerto dataset."
-            echo "   The provided PG credentials needs to have permissions to create databases. All PG permissions are required."
             echo "   -n specifies that you don't want an upgrade script to be auto-generated."
             echo "   -p specifies that this is a preview build."
             echo "   -t turns on tag only mode."
@@ -103,11 +101,27 @@ while getopts ":hv:f:F:nptbrij:cxH:D:U:P:O:" opt; do
             echo "   -j opensrf javascript library path.  If osrf_config is found, the value derived from osrf_config --libdir."
             echo "   -c build the browser client;  requires nodejs"
             echo "   -x skip building the XUL client"
-            echo "   -H Postgres [H]ostname"
-            echo "   -D Postgres [D]atabase name"
-            echo "   -U Postgres [U]sername"
-            echo "   -P Postgres [P]assword"
+            echo "   -H Postgres [H]ostname (optional)"
+            echo "   -D Postgres [D]atabase name (optional)"
+            echo "   -U Postgres [U]sername (optional)"
+            echo "   -P Postgres [P]assword (optional)"
             echo "   -O Postgres p[O]rt"
+            echo ""
+            echo "   Postgres credentials are used to invoke the EXPERIMENTAL"
+            echo "   feature to update the Enhanced Concerto dataset."
+            echo ""
+            echo "   The provided Pg credentials needs to have permissions to create"
+            echo "   databases; using a Pg superuser will be most convenient."
+            echo ""
+            echo "   The commit created by the process to update the dataset"
+            echo "   should be thoroughly reviewed before producing the release."
+            echo ""
+            echo "   Generally, the update of the Enhanced Concerto dataset should"
+            echo "   be done and tested well before the release tarball is built; the main"
+            echo "   dependency is when the database schema becomes stable for the"
+            echo "   release, particularly changes that add or remove tables or"
+            echo "   columns."
+            echo ""
             echo "   NOTE: -t and -b override PREV_BRANCH/PREV_VERSION, but -b overrides -t."
             exit -1
         ;;