Merge pull request #4951 from IntersectMBO/nm/shellcheck

Add a shellcheck workflow to GitHub CI

Author: neilmayhew

.github/workflows/shellcheck.yml

@@ -0,0 +1,35 @@
+name: Shellcheck
+
+# This pipeline runs shellcheck on all shell scripts in the repo.
+#
+# It uses Nix, so that the shellcheck version used is the same as the one used
+# by developers in Nix shells. This ensures the CI's behavior is consistent
+# with the one of developers.
+
+on:
+  push:
+    branches: [ "master", "release/**" ]
+  pull_request:
+  # For running the workflow manually - useful for branches without PRs, for which CI isn't run automatically
+  workflow_dispatch:
+
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: cachix/install-nix-action@v31
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
+      - name: Use nix
+        uses: rrbutani/use-nix-shell-action@v1
+        with:
+          extraNixOptions: --accept-flake-config
+
+      - name: Shellcheck
+        run: |
+          git ls-files scripts | xargs -rd\\n file | egrep 'Bourne|bash' | cut -d: -f1 | xargs -rd\\n shellcheck

flake.nix

@@ -127,6 +127,7 @@
               [
                 (python3.withPackages (ps: with ps; [sphinx sphinx_rtd_theme recommonmark sphinx-markdown-tables sphinxemoji]))
                 haskellPackages.implicit-hie
+                shellcheck
               ];
             # disable Hoogle until someone request it
             withHoogle = false;

scripts/cabal-test-with-retries.sh

@@ -10,7 +10,7 @@ for TRY in $(seq "$TRIES"); do
   echo ">>>>> Testing $PACKAGE ... attempt $TRY of $TRIES <<<<<"
   if cabal test "$PACKAGE"; then
     exit 0
-  elif ! find dist-newstyle -path '*/t/*' -name "$PACKAGE*.log" | xargs grep -h "$CONDITION"; then
+  elif ! find dist-newstyle -path '*/t/*' -name "$PACKAGE*.log" -print0 | xargs -0 grep -h "$CONDITION"; then
     echo "The test failure isn't retryable - aborting"
     exit 1
   fi

scripts/fourmolize.sh

@@ -5,19 +5,18 @@ set -euo pipefail
 if [[ $# -gt 0 ]]; then
   case "$1" in
     --changes)
-      files=$(git diff --diff-filter=MA --name-only origin/master HEAD -- '*.hs')
-      if [[ -n "$files" ]]; then
-        # Run fourmolu on changes compared to `master`.
-        fourmolu -m inplace $(echo "$files" | grep -v Setup.hs)
-      fi
+      # Run fourmolu on changes compared to `master`.
+      git diff --diff-filter=MA --name-only origin/master HEAD -- '*.hs'
       ;;
     *)
       echo "Invalid option: $1" >&2
       exit 1
       ;;
   esac
 else
-  fourmolu -m inplace $(git ls-files -- '*.hs' | grep -v Setup.hs)
-fi
+  git ls-files -- '*.hs'
+fi \
+  | { grep -v Setup.hs || true; } \
+  | xargs -r fourmolu -m inplace
 
 git diff --exit-code

scripts/gen-cddl.sh

@@ -4,10 +4,10 @@ set -euo pipefail
 
 eras=("shelley" "allegra" "mary" "alonzo" "babbage" "conway")
 
-for era in ${eras[@]}; do
+for era in "${eras[@]}"; do
 
   echo "Generating cddl for $era..."
-  cabal run cardano-ledger-$era:exe:huddle-cddl
+  cabal run "cardano-ledger-$era:exe:huddle-cddl"
   echo "Regenerated ${era}.cddl"
 
 done

scripts/ghcid

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-set -euC
+set -euCo pipefail
 
 SNAME=cardano-ledger-ghcid
 
@@ -13,35 +13,36 @@ PACKAGES=(
 )
 
 ghcid_for_package () {
-  local wd="$(pwd)/$1"
-  PACKAGE_NAME=$(get_package_name $wd | xargs basename | sed -e "s/.cabal//")
-  echo $PACKAGE_NAME
-  tmux new-window -d -t "=$SNAME" -n $PACKAGE_NAME -c "$wd"
+  local WD=$PWD/$1
+  PACKAGE_NAME=$(get_package_name "$WD" | xargs basename | sed -e "s/.cabal//")
+  echo "$PACKAGE_NAME"
+  tmux new-window -d -t "=$SNAME" -n "$PACKAGE_NAME" -c "$WD"
   tmux send-keys -t "=$SNAME:=$PACKAGE_NAME" 'ghcid' Enter
 }
 
 # Get the package name for a given directory
 get_package_name () {
-  CABAL_FILE=$(find $1 -maxdepth 1 -name "*.cabal")
-  echo $CABAL_FILE
+  find "$1" -maxdepth 1 -name "*.cabal"
 }
 
-att() {
+attach() {
     [ -n "${TMUX:-}" ] &&
-        tmux switch-client -t "=$SNAME" ||
-        tmux attach-session -t "=$SNAME"
+        {
+          tmux switch-client -t "=$SNAME" ||
+          tmux attach-session -t "=$SNAME"
+        }
 }
 
 if tmux has-session -t "=$SNAME" 2> /dev/null; then
-    att
+    attach
     exit 0
 fi
 
 tmux new-session -d -s $SNAME
 tmux rename-window -t "=$SNAME:0" "cls"
 
-for t in ${PACKAGES[@]}; do
-  ghcid_for_package $t
+for P in "${PACKAGES[@]}"; do
+  ghcid_for_package "$P"
 done
 
-att
+attach

scripts/haskell-language-server

@@ -1,3 +1,4 @@
 #! /usr/bin/env -S nix develop --accept-flake-config -c bash
+# shellcheck shell=bash
 
-haskell-language-server "$@"
+exec haskell-language-server "$@"

scripts/mkprolog.sh

@@ -2,12 +2,14 @@
 
 set -euo pipefail
 
-HADDOCKS_DIR=${1:-"./haddocks"}
-PROLOG_FILE=${2:-"./scripts/prolog"}
+HADDOCKS_DIR=${1:-haddocks}
+PROLOG_FILE=${2:-scripts/prolog}
 
-> ${PROLOG_FILE}
+exec >"$PROLOG_FILE" # Write all stdout to $PROLOG_FILE from here on
 
-cat > ${PROLOG_FILE} << EOF
+cd "$HADDOCKS_DIR"
+
+cat << EOF
 = Cardano Ledger Repository Hackage Documentation
 
 [skip to module list](#module-list)
@@ -16,9 +18,6 @@ This site contains Haskell documentation of:
 
 EOF
 
-for dir in $(ls ${HADDOCKS_DIR}); do
-  if [[ -d ${HADDOCKS_DIR}/${dir} ]]; then
-    link=$(echo "${dir}" | sed "s/:/%3A/g")
-    echo "* __[${dir}](${link}/index.html)__" >> ${PROLOG_FILE}
-  fi
+find -- * -maxdepth 0 -type d | while read -r dir; do
+  echo "* __[$dir](${dir//:/%3A}/index.html)__"
 done