Run shellcheck in CI

Author: smelc

.github/workflows/actionlint.yml

@@ -21,7 +21,7 @@ jobs:
         run: |
           # We want space splitting
           # shellcheck disable=SC2086
-          for file in $(git ls-files .github/workflows/*)
+          for file in $(git ls-files .github/workflows/*.yml)
           do
             echo "Checking $file"
             ${{ steps.get_actionlint.outputs.executable }} -color $file || exit 1

.github/workflows/shellcheck-exceptions.txt

@@ -0,0 +1,27 @@
+name: shellcheck
+# This pipeline runs shellcheck on all files with extension .sh,
+# except the ones listed in .github/workflows/shellcheck-exceptions.txt.
+
+on:
+  push:
+  merge_group:
+  pull_request:
+
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Shellcheck
+        run: |
+          for file in $(git ls-files "*.sh")
+          do
+            if grep -q "$file" ".github/workflows/shellcheck-exceptions.txt"
+            then
+              echo "⚠️ $file is ignored from shellcheck's verifications. Please consider fixing it."
+            else
+              echo "shellcheck \"$file\""
+              shellcheck "$file"
+            fi
+          done

.github/workflows/shellcheck.yml

@@ -1,21 +1,22 @@
 #!/usr/bin/env bash
-set -e
 #
 # Generate the .java files here, taking the snippets
 # from the various *.md files as input
 
-for f in $(ls *.md | grep course)
+set -e
+
+for f in course*.md
 do
-  f_java=$(echo $f | tr -d '-' | sed 's/\.md$/.java/')
+  f_java=$(echo "$f" | tr -d '-' | sed 's/\.md$/.java/')
   f_java="${f_java^}"  # Put first character uppercase
   rm -Rf "$f_java"
-  exdown.py -f java $f > "$f_java" || exit 1
+  exdown.py -f java "$f" > "$f_java" || exit 1
 done
 
-javac *.java
+javac ./*.java
 
 RC="$?"
 
-rm -Rf *.class
+rm -Rf ./*.class
 
 exit "$RC"

slides/build_java.sh

@@ -7,13 +7,13 @@ set -e
 
 EXDOWN="${EXDOWN:-exdown.py}"
 
-for f in $(ls *.md | grep course)
+for f in course*.md
 do
-  hs_module_name=$(echo $f | tr -d '-' | sed 's/\.md$//')
+  hs_module_name=$(echo "$f" | tr -d '-' | sed 's/\.md$//')
   hs_module_name=${hs_module_name^}  # Put first character uppercase
   f_hs="${hs_module_name}.hs"
   rm -Rf "$f_hs"
   echo "$EXDOWN -f hs $f > $f_hs"
-  $EXDOWN -f hs $f > "$f_hs" || exit 1  # exdown is https://github.com/smelc/exdown
+  $EXDOWN -f hs "$f" > "$f_hs" || exit 1  # exdown is https://github.com/smelc/exdown
   echo "Written $f_hs"
 done