ENT-12600: Document and refactor compile-options

.github/workflows/shellcheck.yml

@@ -0,0 +1,24 @@
+name: shellcheck
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: sudo apt install shellcheck
+      - name: Lint sources with shellcheck
+        run: |
+          # Recursively find all shell scripts in the build-scripts directory with a shebang
+          grep -Erl '^(#!/(bin|usr/bin)/(env )?(sh|bash))' build-scripts/ | while read -r file; do
+              shellcheck --external-sources --source-path=build-scripts "$file"
+          done

build-scripts/bootstrap-tarballs

@@ -112,9 +112,7 @@ run_and_print_on_failure ./configure
 echo "$(basename "$0"): Debug: Running make dist on masterfiles repository..."
 run_and_print_on_failure make dist # source tarball
 echo "$(basename "$0"): Debug: Running make tar-package on masterfiles repository..."
-run_and_print_on_failure make tar-package # package tarball (containing all
-# files as if they were installed
-# under "prefix".)
+run_and_print_on_failure make tar-package # package tarball (containing all files as if they were installed under "prefix".)
 mv cfengine-masterfiles*.tar.gz "$BASEDIR"/output/tarballs/
 echo "$(basename "$0"): Debug: Running make distclean on masterfiles repository..."
 run_and_print_on_failure make distclean

build-scripts/build-environment-check

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-. $(dirname "$0")/functions
+. "$(dirname "$0")"/functions
 . detect-environment
 . compile-options
 
@@ -45,17 +45,17 @@ DEP_LIST="$DEP_LIST rsync gcc make sudo wget"
 
 RET=0
 for unwanted in $UNWANTED_DEPS; do
-    if query_pkg $unwanted; then
-        echo "ERROR Found unwanted package:" $unwanted
+    if query_pkg "$unwanted"; then
+        echo "ERROR Found unwanted package: $unwanted"
         RET=1
     fi
 done
 
 for dep in $DEP_LIST; do
-    if query_pkg $dep; then
+    if query_pkg "$dep"; then
         true
     else
-        echo "ERROR Missing system package:" $dep
+        echo "ERROR Missing system package: $dep"
         RET=1
     fi
 done

build-scripts/clean-results

@@ -1,6 +1,6 @@
 #!/bin/sh -ex
 
-. $(dirname "$0")/functions
+. "$(dirname "$0")"/functions
 . version
 
 # This script is designed to clean up old directories, specifically keeping the

build-scripts/compile

@@ -34,24 +34,24 @@ nova)
 esac
 
 echo "$(basename "$0"): Debug: Running make in core repo..."
-run_and_print_on_failure $MAKE -C "$BASEDIR"/core -k
+run_and_print_on_failure "$MAKE" -C "$BASEDIR"/core -k
 echo "$(basename "$0"): Debug: Running make install in core repo..."
-run_and_print_on_failure $MAKE -C "$BASEDIR"/core install DESTDIR="$BASEDIR"/cfengine/dist
+run_and_print_on_failure "$MAKE" -C "$BASEDIR"/core install DESTDIR="$BASEDIR"/cfengine/dist
 
 if [ "$NOVA" = yes ]; then
     echo "$(basename "$0"): Debug: Running make in enterprise repo..."
-    run_and_print_on_failure $MAKE -C "$BASEDIR"/enterprise -k
+    run_and_print_on_failure "$MAKE" -C "$BASEDIR"/enterprise -k
     echo "$(basename "$0"): Debug: Running make install in enterprise repo..."
-    run_and_print_on_failure $MAKE -C "$BASEDIR"/enterprise install DESTDIR="$BASEDIR"/cfengine/dist
+    run_and_print_on_failure "$MAKE" -C "$BASEDIR"/enterprise install DESTDIR="$BASEDIR"/cfengine/dist
     if [ "$ROLE" = hub ]; then
         echo "$(basename "$0"): Debug: Running make in nova repo..."
-        run_and_print_on_failure $MAKE -C "$BASEDIR"/nova -k
+        run_and_print_on_failure "$MAKE" -C "$BASEDIR"/nova -k
         echo "$(basename "$0"): Debug: Running make install in nova repo..."
-        run_and_print_on_failure $MAKE -C "$BASEDIR"/nova install DESTDIR="$BASEDIR"/cfengine/dist
+        run_and_print_on_failure "$MAKE" -C "$BASEDIR"/nova install DESTDIR="$BASEDIR"/cfengine/dist
         echo "$(basename "$0"): Debug: Running make install in masterfiles repo..."
-        run_and_print_on_failure $MAKE -C "$BASEDIR"/masterfiles install DESTDIR="$BASEDIR"/cfengine/dist
+        run_and_print_on_failure "$MAKE" -C "$BASEDIR"/masterfiles install DESTDIR="$BASEDIR"/cfengine/dist
     fi
 else
     echo "$(basename "$0"): Debug: Running make install in masterfiles repo..."
-    run_and_print_on_failure $MAKE -C "$BASEDIR"/masterfiles install DESTDIR="$BASEDIR"/cfengine/dist
+    run_and_print_on_failure "$MAKE" -C "$BASEDIR"/masterfiles install DESTDIR="$BASEDIR"/cfengine/dist
 fi