Add buildArgs input to pass --build-args to convox build/deploy

Each space/newline-separated KEY=VALUE pair becomes a separate
--build-args flag on both the build and deploy entrypoints. Enables
injecting Docker ARG values (e.g. a setuptools_scm pretend-version)
into external builds.

Author: dberenbaum

README.md

@@ -120,8 +120,13 @@ Builds the app and returns the release ID.
     cached: true          # optional, default true
     external: false       # optional, default false
     manifest: convox.yml  # optional
+    buildArgs: FOO=1 BAR=2  # optional; each pair becomes a --build-args flag
 ```
 
+`buildArgs` accepts space- or newline-separated `KEY=VALUE` pairs (values with
+spaces are not supported). Use it to pass Docker `ARG` values into the build,
+e.g. `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_MYPKG=1.2.3`.
+
 ### deploy
 
 Builds and deploys in a single operation (waits for completion).
@@ -134,6 +139,7 @@ Builds and deploys in a single operation (waits for completion).
     app: my-app
     description: "Deploy ${{ github.sha }}"
     external: false       # optional, default false
+    buildArgs: FOO=1 BAR=2  # optional; same format as build
 ```
 
 ### build-migrate

VERSION

@@ -1 +1 @@
-v3.3.2
+v3.4.0

action.yml

@@ -41,6 +41,11 @@ inputs:
     description: Build the image locally and push directly to the rack registry, bypassing the load balancer upload
     required: false
     default: false
+  buildArgs:
+    description: >-
+      (build) Docker build args in the form 'KEY1=VALUE1 KEY2=VALUE2', or
+      newline-separated pairs. Each is passed to convox build as --build-args.
+    required: false
   manifest:
     description: Use a custom path for your convox.yml
     required: false
@@ -145,6 +150,7 @@ runs:
         INPUT_CACHED: ${{ inputs.cached }}
         INPUT_ERRORONZEROSCALE: ${{ inputs.errorOnZeroScale }}
         INPUT_EXTERNAL: ${{ inputs.external }}
+        INPUT_BUILDARGS: ${{ inputs.buildArgs }}
         INPUT_MANIFEST: ${{ inputs.manifest }}
         INPUT_PARAMNAME: ${{ inputs.paramName }}
         INPUT_PARAMVALUE: ${{ inputs.paramValue }}

entrypoint-build.sh

@@ -13,6 +13,20 @@ if [ "$INPUT_CACHED" = "false" ]; then set -- "$@" --no-cache; fi
 if [ -n "$INPUT_MANIFEST" ]; then set -- "$@" -m "$INPUT_MANIFEST"; fi
 if [ "$INPUT_EXTERNAL" = "true" ]; then set -- "$@" --external; fi
 
+# Append --build-args for each KEY=VALUE in INPUT_BUILDARGS (space- or
+# newline-separated). ponytail: values with spaces aren't supported; use
+# newline-separated env-style parsing if a build arg ever needs one.
+if [ -n "$INPUT_BUILDARGS" ]; then
+  old_ifs="$IFS"
+  IFS="$(printf ' \n\t')"
+  set -f
+  for pair in $INPUT_BUILDARGS; do
+    [ -n "$pair" ] && set -- "$@" --build-args "$pair"
+  done
+  set +f
+  IFS="$old_ifs"
+fi
+
 release=$(convox build "$@")
 
 if [ -z "$release" ]; then

entrypoint-deploy.sh

@@ -15,4 +15,17 @@ if [ "$INPUT_CACHED" = "false" ]; then set -- "$@" --no-cache; fi
 if [ -n "$INPUT_MANIFEST" ]; then set -- "$@" -m "$INPUT_MANIFEST"; fi
 if [ "$INPUT_EXTERNAL" = "true" ]; then set -- "$@" --external; fi
 
+# Append --build-args for each KEY=VALUE in INPUT_BUILDARGS (space- or
+# newline-separated). ponytail: values with spaces aren't supported.
+if [ -n "$INPUT_BUILDARGS" ]; then
+  old_ifs="$IFS"
+  IFS="$(printf ' \n\t')"
+  set -f
+  for pair in $INPUT_BUILDARGS; do
+    [ -n "$pair" ] && set -- "$@" --build-args "$pair"
+  done
+  set +f
+  IFS="$old_ifs"
+fi
+
 convox deploy "$@" --wait

tests/entrypoints.bats

@@ -467,6 +467,39 @@ exit 1'
   grep -q -- "--external" "$CONVOX_CALLS"
 }
 
+@test "build: each buildArgs pair is passed as a separate --build-args flag" {
+  # argc assertion proves both pairs arrive as separate --build-args flags.
+  stub_convox 'echo "argc=$#" >> "$CONVOX_CALLS"; echo R123'
+  export INPUT_APP="my-app"
+  export INPUT_RACK="my-rack"
+  export INPUT_DESCRIPTION="test-desc"
+  export INPUT_BUILDARGS="FOO=1 BAR=2"
+
+  run sh entrypoint-build.sh
+
+  [ "$status" -eq 0 ]
+  # argv: build --app my-app --description test-desc --id --build-args FOO=1 --build-args BAR=2 = 10
+  grep -q "^argc=10$" "$CONVOX_CALLS"
+  grep -F -q "FOO=1" "$CONVOX_CALLS"
+  grep -F -q "BAR=2" "$CONVOX_CALLS"
+}
+
+@test "deploy: each buildArgs pair is passed as a separate --build-args flag" {
+  stub_convox 'echo "argc=$#" >> "$CONVOX_CALLS"'
+  export INPUT_APP="my-app"
+  export INPUT_RACK="my-rack"
+  export INPUT_DESCRIPTION="test-desc"
+  export INPUT_BUILDARGS="FOO=1 BAR=2"
+
+  run sh entrypoint-deploy.sh
+
+  [ "$status" -eq 0 ]
+  # argv: deploy --app my-app --description test-desc --build-args FOO=1 --build-args BAR=2 --wait = 10
+  grep -q "^argc=10$" "$CONVOX_CALLS"
+  grep -F -q "FOO=1" "$CONVOX_CALLS"
+  grep -F -q "BAR=2" "$CONVOX_CALLS"
+}
+
 # ---------------------------------------------------------------------------
 # GITHUB_OUTPUT / GITHUB_ENV channel split (plan 009)
 # ---------------------------------------------------------------------------