add shellcheck action to lint bash scripts (#3710)

* add shellcheck action to lint bash scripts

* fix some shellcheck warnings

---------

Co-authored-by: ds <ds@local>
Co-authored-by: Burak Yigit Kaya <[email protected]>

Author: 3 people

.github/workflows/shellcheck.yml

@@ -0,0 +1,40 @@
+---
+name: "ShellCheck"
+on:
+  push:
+    paths:
+      - "**.sh"
+    branches: [master]
+  pull_request:
+    paths:
+      - "**.sh"
+    branches: [master]
+
+jobs:
+  shellcheck:
+    name: ShellCheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Repository checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run ShellCheck
+        run: |
+          git diff --name-only -z `git merge-base origin/master HEAD` -- \
+            'install/_lib.sh' \
+          | xargs -0 -r -- \
+            shellcheck \
+              --shell=bash \
+              --exclude=SC1090,SC1091 \
+              --format=json1 \
+          | jq -r '
+            .comments
+            | map(.level |= if ([.] | inside(["info", "style"])) then "notice" else . end)
+            | .[] as $note
+            | "::\($note.level) file=\($note.file),line=\($note.line),endLine=\($note.endLine),col=\($note.column),endColumn=\($note.endColumn)::[SC\($note.code)] \($note.message)"
+          ' \
+          | grep . >&2 && exit 1
+
+          exit 0

install/_lib.sh

@@ -33,6 +33,7 @@ function ensure_file_from_example {
     echo "$target already exists, skipped creation."
   else
     # sed from https://stackoverflow.com/a/25123013/90297
+    # shellcheck disable=SC2001
     example="$(echo "$target" | sed 's/\.[^.]*$/.example&/')"
     if [[ ! -f "$example" ]]; then
       echo "Oops! Where did $example go? 🤨 We need it in order to create $target."
@@ -45,14 +46,14 @@ function ensure_file_from_example {
 
 # Check the version of $1 is greater than or equal to $2 using sort. Note: versions must be stripped of "v"
 function vergte() {
-  printf "%s\n%s" $1 $2 | sort --version-sort --check=quiet --reverse
+  printf "%s\n%s" "$1" "$2" | sort --version-sort --check=quiet --reverse
 }
 
-SENTRY_CONFIG_PY=sentry/sentry.conf.py
-SENTRY_CONFIG_YML=sentry/config.yml
+export SENTRY_CONFIG_PY=sentry/sentry.conf.py
+export SENTRY_CONFIG_YML=sentry/config.yml
 
 # Increase the default 10 second SIGTERM timeout
 # to ensure celery queues are properly drained
 # between upgrades as task signatures may change across
 # versions
-STOP_TIMEOUT=60 # seconds
+export STOP_TIMEOUT=60 # seconds