provide github ref override

Author: isaacbrodsky

.github/workflows/tests.yml

@@ -195,6 +195,6 @@ jobs:
 
       - name: Download and test
         run: |
-          mvn clean test -Dh3.github.artifacts=true
+          mvn clean test -Dh3.github.artifacts.use=true -Dh3.github.artifacts.ref=${{ github.ref }}
         env:
           GH_TOKEN: ${{ github.token }}

docs/releasing.md

@@ -8,8 +8,8 @@ Release builds should only be run on Mac OSX with Docker. This is needed so that
 
 1. Ensure you are on branch `master` and that the library is building correctly.
 2. Update [CHANGELOG.md](../CHANGELOG.md) to have the correct date and new version number, update [README.md](../README.md) to have the correct version numbers, and commit.
-3. `mvn release:prepare -Dh3.github.artifacts=true` Use the new version number when prompted.
-4. `mvn release:perform -Dh3.github.artifacts=true`
+3. `mvn release:prepare -Dh3.github.artifacts.use=true` Use the new version number when prompted.
+4. `mvn release:perform -Dh3.github.artifacts.use=true`
 5. If this looks good, close and release the build in [Sonatype Nexus Manager](https://oss.sonatype.org/).
 6. Update `CHANGELOG.md` to have an Unreleased section, and commit. The release is now done and development can resume from this point.
 

pom.xml

@@ -72,7 +72,8 @@
         <h3.use.docker>true</h3.use.docker>
         <h3.system.prune>false</h3.system.prune>
         <h3.dockcross.tag>20210624-de7b1b0</h3.dockcross.tag>
-        <h3.github.artifacts>false</h3.github.artifacts>
+        <h3.github.artifacts.use>false</h3.github.artifacts.use>
+        <h3.github.artifacts.ref />
         <!-- Used for passing additional arguments to surefire when using JaCoCo -->
         <h3.additional.argLine />
 
@@ -263,14 +264,7 @@
                         </goals>
                         <configuration>
                             <executable>${basedir}/src/main/c/h3-java/build-h3.sh</executable>
-                            <arguments>
-                                <argument>${h3.git.remote}</argument>
-                                <argument>${h3.git.reference}</argument>
-                                <argument>${h3.use.docker}</argument>
-                                <argument>${h3.system.prune}</argument>
-                                <argument>${h3.dockcross.tag}</argument>
-                                <argument>${h3.github.artifacts}</argument>
-                            </arguments>
+                            <commandlineArgs>${h3.git.remote} ${h3.git.reference} ${h3.use.docker} ${h3.system.prune} ${h3.dockcross.tag} ${h3.github.artifacts.use} ${h3.github.artifacts.ref}</commandlineArgs>
                         </configuration>
                     </execution>
                 </executions>

src/main/c/h3-java/build-h3.sh

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-# Arguments: [git-remote] [git-ref] [use-docker] [remove-images] [github-artifacts]
+# Arguments: [git-remote] [git-ref] [use-docker] [remove-images] [github-artifacts] [github-artifacts-ref]
 # git-remote       - The git remote to pull from. An existing cloned repository
 #                    will not be deleted if a new remote is specified.
 # git-ref          - Specific git ref of H3 to build.
@@ -28,6 +28,8 @@
 # github-artifacts - When set, all build artifacts are retrieved from Github
 #                    Actions artifacts rather than built locally (overrides
 #                    all other settings.)
+# github-artifacts-ref - When set, override the default revision to pull artifacts from
+#                        for `github-artifacts`.
 #
 # This script downloads H3, builds H3 and the H3-Java native library, and
 # cross compiles via Docker.
@@ -42,11 +44,12 @@ GIT_REVISION=$2
 USE_DOCKER=$3
 SYSTEM_PRUNE=$4
 DOCKCROSS_TAG=$5
-PULL_FROM_GITHUB=$6
+GITHUB_ARTIFACTS=$6
+GITHUB_ARTIFACTS_REF=$7
 
 if $PULL_FROM_GITHUB; then
-    src/main/c/h3-java//pull-from-github.sh
-    exit 0
+    src/main/c/h3-java/pull-from-github.sh "$GITHUB_ARTIFACTS_REF"
+    # The build of the library below is still needed for the binding-functions file
 fi
 
 echo Downloading H3 from "$GIT_REMOTE"
@@ -99,6 +102,11 @@ cp h3-java-build/build/binding-functions .
 
 popd # target
 
+if $PULL_FROM_GITHUB; then
+    # Nothing more is needed than the binding-functions to stop now.
+    exit 0
+fi
+
 # Copy the built artifact for this platform.
 case "$(uname -sm)" in
     "Linux x86_64")  LIBRARY_DIR=linux-x64 ;;

src/main/c/h3-java/pull-from-github.sh

@@ -24,7 +24,13 @@
 
 set -eox pipefail
 
-GIT_REVISION=$(git rev-parse HEAD)
+GITHUB_ARTIFACTS_REF=$1
+
+if [ -z "$GITHUB_ARTIFACTS_REF" ]; then
+    GIT_REVISION=$(git rev-parse HEAD)
+else
+    GIT_REVISION="$GITHUB_ARTIFACTS_REF"
+fi
 EXTRACT_TO=src/main/resources
 
 echo downloading artifacts for $GIT_REVISION