cross link some docs #7000

IQSS · Dec 16, 2022 · 4ed1013 · 4ed1013
1 parent da9c8ea
commit 4ed1013
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/doc/sphinx-guides/source/developers/making-releases.rst b/doc/sphinx-guides/source/developers/making-releases.rst
@@ -95,6 +95,8 @@ At this point you can send around the draft release for any final feedback. Link
 
 Make corrections to the draft, if necessary. It will be out of sync with the .md file, but that's ok (`#7988 <https://github.com/IQSS/dataverse/issues/7988>`_ is tracking this).
 
+.. _run-build-create-war:
+
 Run a Build to Create the War File
 ----------------------------------
 
@@ -110,6 +112,15 @@ Click "Save" then "Build Now".
 
 The build number will appear in ``/api/info/version`` (along with the commit mentioned above) from a running installation (e.g. ``{"version":"5.10.1","build":"907-b844672``).
 
+Note that the build number comes from script in an early build step...
+
+.. code-block:: bash
+
+  COMMIT_SHA1=`echo $GIT_COMMIT | cut -c-7`
+  echo "build.number=${BUILD_NUMBER}-${COMMIT_SHA1}" > $WORKSPACE/src/main/java/BuildNumber.properties
+
+... but we can explore alternative methods of specifying the build number, as described in :ref:`auto-custom-build-number`.
+
 Build Installer (dvinstall.zip)
 -------------------------------
 

diff --git a/doc/sphinx-guides/source/developers/tips.rst b/doc/sphinx-guides/source/developers/tips.rst
@@ -58,6 +58,8 @@ From the root of the git repo, run the following command to set the build number
 
 This should update or place a file at ``src/main/java/BuildNumber.properties``.
 
+(See also :ref:`auto-custom-build-number` for other ways of changing the build number.)
+
 Then, from Netbeans, click "Run" and then "Clean and Build Project (dataverse)". After this completes successfully, click "Run" and then "Run Project (dataverse)"
 
 Confirm the Change Was Deployed
@@ -164,6 +166,8 @@ Git on Mac
 
 On a Mac, you won't have git installed unless you have "Command Line Developer Tools" installed but running ``git clone`` for the first time will prompt you to install them.
 
+.. _auto-custom-build-number:
+
 Automation of Custom Build Number on Webpage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -180,6 +184,8 @@ environment variable (``DATAVERSE_BUILD``) or `one of the other config sources
 You could even override the version itself with the option ``dataverse.version`` in the same way, which is usually
 picked up from a build time source.
 
+See also discussion of version numbers in :ref:`run-build-create-war`.
+
 Sample Data
 -----------