Clean up docker/build.sh

 - Move usage check to the top, to serve as documentation for people
   who read the script.

 - Remove `-x` from shebang line (#!), to only enable tracing in CI.

 - Fix `set -x` call (previously it was inside the `if` condition,
   which is wrong).

 - Remove PS4 variable (which adds info to the trace) because sh does
   not support LINENO, and the rest of the info is not that useful.

 - Inline `trace_off` into section_start and section_end to produce
   less noise in the trace. (The "section_start" lines will still be
   displayed though. Hiding them is tricky; see
   DOMjudge/domjudge/gitlab/integration.sh for an example, but note
   that it requires bash for `shopt -s expand_aliases`.)

 - Make the no-op placeholders for section_start and section_end
   produce less noise in the trace.

 - Redirect stderr to stdout as a workaround for a GitHub Actions
   issue that causes them to appear out-of-order.

 - Simplify initialisation of NAMESPACE variable to make the trace
   look nicer.

 - Put the variable assignments in a log group to make it look nicer.

 - Fix the invocation of build.sh in the build-domjudge-container-*
   workflows to use `./build.sh` rather than `sh ./build.sh` so that
   the options in the shebang line will be respected. Also remove
   unnecessary calls to `set -x` in the workflows.

Author: tom93

.github/workflows/build-domjudge-container-PR.yml

@@ -65,9 +65,7 @@ jobs:
       - name: Build the container
         run: |
           cd docker
-          set -x
-          sh ./build.sh "${{ env.DOMJUDGE_VERSION }}"
-          set +x
+          ./build.sh "${{ env.DOMJUDGE_VERSION }}"
 
       - name: Build and push
         run: |

.github/workflows/build-domjudge-container-release.yml

@@ -65,9 +65,7 @@ jobs:
       - name: Build the container
         run: |
           cd docker
-          set -x
-          sh ./build.sh "${{ env.DOMJUDGE_VERSION }}"
-          set +x
+          ./build.sh "${{ env.DOMJUDGE_VERSION }}"
 
       - name: Build and push
         run: |

docker/build.sh

@@ -1,72 +1,59 @@
-#!/bin/sh -eux
+#!/bin/sh -eu
 
-# Placeholders to annotate the Github actions logs
-trace_on () { true; }
-trace_off () { true; }
-section_start () { true; }
-section_end () { true; }
+if [ "$#" -eq 0 ] || [ "$#" -gt 2 ]
+then
+	echo "Usage: $0 domjudge-version <namespace>"
+	echo "	For example: $0 5.3.0"
+	echo "	or: $0 5.3.0 otherNamespace"
+	exit 1
+fi
+
+# Placeholders for grouping log lines
+# (the body is a nested function declaration so it won't appear in the trace when using `set -x`)
+section_start() { _() { :; }; }
+section_end() { _() { :; }; }
 
 if [ -n "${CI+x}" ]
 then
 	if [ -n "${GITHUB_ACTION+x}" ]
-	set -x
 	then
-		# Functions to annotate the Github actions logs
-		trace_on () { set -x; }
-		trace_off () {
-			{ set +x; } 2>/dev/null
-		}
-		
-		section_start_internal () {
+		# Functions for grouping log lines on GitHub Actions
+		trace_on() { set -x; }
+		# trace_off is manually inlined so it won't appear in the trace
+		section_start() {
+			{ set +x; } 2>/dev/null # trace_off
 			echo "::group::$1"
 			trace_on
 		}
-		
-		section_end_internal () {
+		section_end() {
+			{ set +x; } 2>/dev/null # trace_off
 			echo "::endgroup::"
 			trace_on
 		}
-		
-		section_start () {
-			trace_off
-			section_start_internal "$@"
-		}
-		section_end () {
-			trace_off
-			section_end_internal
-		}
-	else
-		export PS4='(${0}:${LINENO}): - [$?] $ '
+		# Redirect stderr to stdout as a workaround so they won't be out-of-order; see
+		# https://github.com/orgs/community/discussions/116552
+		# https://web.archive.org/web/20220430214837/https://github.community/t/stdout-stderr-output-not-in-correct-order-in-logs/16335
+		# (GitHub Actions displays stderr in the same style as stdout anyway, so
+		# there is no harm in us merging them.)
+		exec 2>&1
 	fi
+	set -x
 fi
 
-if [ "$#" -eq 0 ] || [ "$#" -gt 2 ]
-then
-	echo "Usage: $0 domjudge-version <namespace>"
-	echo "	For example: $0 5.3.0"
-	echo "	or: $0 5.3.0 otherNamespace"
-	exit 1
-fi
-
+section_start "Variables"
 VERSION="$1"
-NAMESPACE="domjudge"
-if [ -n "${2+x}" ]
-then
-	NAMESPACE="$2"
-fi
-
+NAMESPACE="${2-domjudge}"
 URL=https://www.domjudge.org/releases/domjudge-${VERSION}.tar.gz
 FILE=domjudge.tar.gz
+section_end
 
 section_start "Download DOMjudge tarball"
 echo "[..] Downloading DOMjudge version ${VERSION}..."
-
 if ! wget --quiet "${URL}" -O ${FILE}
 then
 	echo "[!!] DOMjudge version ${VERSION} file not found on https://www.domjudge.org/releases"
 	exit 1
 fi
-
 echo "[ok] DOMjudge version ${VERSION} downloaded as domjudge.tar.gz"; echo
 section_end