Add shellcheck support (workflow to detect/not fix) and fix scripts to pass checks

.github/workflows/shellcheck.yml

@@ -0,0 +1,26 @@
+---
+name: Shellcheck
+
+on:
+  push:
+    branches: [3.x]
+  pull_request:
+    branches: [3.x]
+
+permissions:
+  contents: read
+
+jobs:
+  shellcheck:
+    name: Check shell scripts
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: |
+          sudo apt update && sudo apt install -y shellcheck
+      - name: shellcheck
+        run: |
+          git grep -l '^#\( *shellcheck \|!\(/bin/\|/usr/bin/env \)\(sh\|bash\|dash\|ksh\)\)' | xargs shellcheck

scripts/build-public-docs.sh

@@ -26,11 +26,11 @@ fi
 
 if [ -n "${TAG_NAME}" ] && [[ "$TAG_NAME" =~ ^v[0-9]\.[0-9]+([\.a-z0-9]+)?$ ]]; then
     echo "Building ${BRANCH_NAME} docs for tag: ${TAG_NAME}"
-    env DOCS_VERSION=$BRANCH_NAME sphinx-build -a docs/ docs/public/en/$BRANCH_NAME/
+    env DOCS_VERSION="$BRANCH_NAME" sphinx-build -a docs/ docs/public/en/"$BRANCH_NAME"/
 
     if [ "${BRANCH_NAME}" = "${LATEST_BRANCH}" ]; then
         echo "Generating /page redirects"
-        env DOCS_VERSION=$BRANCH_NAME python scripts/generate_redirect_pages.py
+        env DOCS_VERSION="$BRANCH_NAME" python scripts/generate_redirect_pages.py
     fi
 fi
 

scripts/dev-test.sh

@@ -3,6 +3,6 @@
 set -euo pipefail
 
 echo "Execute pytest..."
-pytest $@
+pytest "$@"
 
 echo "Tests complete!"

scripts/release.sh

@@ -1,9 +1,9 @@
-#!/bin/sh
+#!/bin/bash
 
 set -euo pipefail
 
-VERSION=`python setup.py --version`
-MAJOR_BRANCH="`python setup.py --version | cut -d'.' -f1`.x"
+VERSION=$(python setup.py --version)
+MAJOR_BRANCH="$(python setup.py --version | cut -d'.' -f1).x"
 
 echo "# Releasing pyinfra v${VERSION} (branch ${MAJOR_BRANCH})"