Add shellcheck + necessary changes in the scripts

ruzickap · May 11, 2020 · 5ac9fe1 · 5ac9fe1
1 parent 93c9b47
commit 5ac9fe1
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 26 deletions.
diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
@@ -0,0 +1,23 @@
+name: shellcheck
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    paths:
+      - '**.sh'
+      - .github/workflows/shellcheck.yml
+  push:
+    branches:
+      - master
+    paths:
+      - '**.sh'
+      - .github/workflows/shellcheck.yml
+
+jobs:
+  shellcheck-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Lint check
+        uses: azohra/shell-linter@v0.3.0
diff --git a/.github/workflows/vuepress-build-check-deploy.yml b/.github/workflows/vuepress-build-check-deploy.yml
@@ -47,7 +47,7 @@ jobs:
         run: npm install -g markdown-spellcheck
 
       - name: Run mdspell
-        run: find . -type f -name "*.md" | xargs --max-args=1 --verbose  mdspell --ignore-numbers --ignore-acronyms --report --en-gb
+        run: find . -type f -name "*.md" | xargs --max-args=1 --verbose mdspell --ignore-numbers --ignore-acronyms --report --en-gb
 
   vuepress-build-check-deploy:
     runs-on: ubuntu-latest

diff --git a/run-k8s-istio-webinar-full.sh b/run-k8s-istio-webinar-full.sh
@@ -1,9 +1,12 @@
 #!/usr/bin/env bash
 
+set -eu
+
 ################################################
 # include the magic
 ################################################
 test -f ./demo-magic.sh || curl --silent https://raw.githubusercontent.com/paxtonhare/demo-magic/master/demo-magic.sh > demo-magic.sh
+# shellcheck disable=SC1091
 . ./demo-magic.sh -n
 
 ################################################
@@ -13,7 +16,7 @@ test -f ./demo-magic.sh || curl --silent https://raw.githubusercontent.com/paxto
 #
 # speed at which to simulate typing. bigger num = faster
 #
-TYPE_SPEED=60
+export TYPE_SPEED=60
 
 # Uncomment to run non-interactively
 export PROMPT_TIMEOUT=0
@@ -27,7 +30,7 @@ export NO_WAIT=false
 # see http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/bash-prompt-escape-sequences.html for escape sequences
 #
 #DEMO_PROMPT="${GREEN}➜ ${CYAN}\W "
-DEMO_PROMPT="${GREEN}➜ ${CYAN}$ "
+export DEMO_PROMPT="${GREEN}➜ ${CYAN}$ "
 
 # hide the evidence
 clear
@@ -47,16 +50,13 @@ clear
 # ./run-k8s-istio-webinar-full.sh
 
 sed '/^## Configure AWS/,/^Create policy allowing the cert-manager to change Route 53 settings./d' docs/part-{01..08}/README.md | \
-sed -n '/^```bash$/,/^```$/p;/^-----$/p'  | \
-sed -e 's/^-----$/\
-p  ""\
-p  "################################################################################################### Press <ENTER> to continue"\
-wait\
-/' \
--e 's/^```bash$/\
-pe '"'"'/' \
--e 's/^```$/'"'"'/' \
--e '/^sleep/d' \
+sed -n "/^\`\`\`bash.*/,/^\`\`\`$/p;/^-----$/p" | \
+sed \
+  -e 's/^-----$/\np  ""\np  "################################################################################################### Press <ENTER> to continue"\nwait\n/' \
+  -e 's/^```bash.*/\npe '"'"'/' \
+  -e 's/^```$/'"'"'/' \
+  -e '/^sleep/d' \
 > README.sh
 
+# shellcheck disable=SC1091
 source README.sh
diff --git a/run-k8s-istio-webinar.sh b/run-k8s-istio-webinar.sh
@@ -1,9 +1,12 @@
 #!/usr/bin/env bash
 
+set -eu
+
 ################################################
 # include the magic
 ################################################
 test -f ./demo-magic.sh || curl --silent https://raw.githubusercontent.com/paxtonhare/demo-magic/master/demo-magic.sh > demo-magic.sh
+# shellcheck disable=SC1091
 . ./demo-magic.sh -n
 
 ################################################
@@ -13,7 +16,7 @@ test -f ./demo-magic.sh || curl --silent https://raw.githubusercontent.com/paxto
 #
 # speed at which to simulate typing. bigger num = faster
 #
-TYPE_SPEED=60
+export TYPE_SPEED=60
 
 # Uncomment to run non-interactively
 export PROMPT_TIMEOUT=0
@@ -27,7 +30,7 @@ export NO_WAIT=false
 # see http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/bash-prompt-escape-sequences.html for escape sequences
 #
 #DEMO_PROMPT="${GREEN}➜ ${CYAN}\W "
-DEMO_PROMPT="${GREEN}➜ ${CYAN}$ "
+export DEMO_PROMPT="${GREEN}➜ ${CYAN}$ "
 
 # hide the evidence
 clear
@@ -49,22 +52,19 @@ clear
 
 # ./run-k8s-istio-webinar.sh
 
-if [ -z ${EKS_CERT_MANAGER_ROUTE53_AWS_ACCESS_KEY_ID+x} ] || [ -z ${EKS_CERT_MANAGER_ROUTE53_AWS_SECRET_ACCESS_KEY+x} ]; then
+if [ -z "${EKS_CERT_MANAGER_ROUTE53_AWS_ACCESS_KEY_ID+x}" ] || [ -z "${EKS_CERT_MANAGER_ROUTE53_AWS_SECRET_ACCESS_KEY+x}" ]; then
   echo "One of the mandatory variables 'EKS_CERT_MANAGER_ROUTE53_AWS_ACCESS_KEY_ID' or 'EKS_CERT_MANAGER_ROUTE53_AWS_SECRET_ACCESS_KEY' is not set !!";
   exit 1
 fi
 
 sed '/^## Prepare the local working environment/,/^Check if the new EKS cluster is available:/d' docs/part-{01..08}/README.md | \
-sed -n '/^```bash$/,/^```$/p;/^-----$/p'  | \
-sed -e 's/^-----$/\
-p  ""\
-p  "################################################################################################### Press <ENTER> to continue"\
-wait\
-/' \
--e 's/^```bash$/\
-pe '"'"'/' \
--e 's/^```$/'"'"'/' \
--e '/^sleep/d' \
+sed -n "/^\`\`\`bash.*/,/^\`\`\`$/p;/^-----$/p" | \
+sed \
+  -e 's/^-----$/\np  ""\np  "################################################################################################### Press <ENTER> to continue"\nwait\n/' \
+  -e 's/^```bash.*/\npe '"'"'/' \
+  -e 's/^```$/'"'"'/' \
+  -e '/^sleep/d' \
 > README.sh
 
+# shellcheck disable=SC1091
 source README.sh