chore: add ShellCheck action (#7)

* chore: add ShellCheck action * suggestions from ShellCheck * suggestions from ShellCheck * use jq --arg instead of ShellCheck's suggestion * fix: actionlint and shellcheck workflow triggers * chore: bump checkout action version in actionlint.yml --------- Co-authored-by: austinletson <[email protected]>
leanprover · May 9, 2024 · 788e73f · 788e73f
1 parent 3c111d3
commit 788e73f
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 5 deletions.
diff --git a/.github/workflows/actionlint.yml b/.github/workflows/actionlint.yml
@@ -0,0 +1,21 @@
+name: Actionlint
+on:
+  push:
+    branches:
+      - 'main'
+    paths:
+      - '.github/**'
+  pull_request:
+    paths:
+      - '.github/**'
+
+jobs:
+  actionlint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: actionlint
+      uses: raven-actions/actionlint@v1
+      with:
+        pyflakes: false # we do not use python scripts
diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
@@ -0,0 +1,15 @@
+name: ShellCheck
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+
+jobs:
+    lint:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout code
+          uses: actions/checkout@v4
+        - name: Run ShellCheck
+          uses: azohra/[email protected]
diff --git a/scripts/check_reservoir_eligibility.sh b/scripts/check_reservoir_eligibility.sh
@@ -14,7 +14,7 @@ function check_license() {
   SPDX_DATA_URL="https://raw.githubusercontent.com/spdx/license-list-data/main/json/licenses.json"
 
   # Fetch the SPDX license list and filter by licenseId and isOsiApproved
-  license=$(curl -s $SPDX_DATA_URL | jq -r '.licenses[] | select(.licenseId == "'$id'" and .isOsiApproved == true)')
+  license=$(curl -s "$SPDX_DATA_URL" | jq -r --arg id "$id" '.licenses[] | select(.licenseId == $id and .isOsiApproved == true)')
   if [ -n "$license" ]; then
       return 0
   else
@@ -24,7 +24,7 @@ function check_license() {
 }
 
 # Check if the license_id is a valid SPDX license and assign exit code
-if ! check_license $license_id; then
+if ! check_license "$license_id"; then
   echo "Package is ineligible for Reservoir because the repository does not contain a valid SPDX license."
   exit_code=1
 fi
@@ -36,13 +36,13 @@ if [ ! -f "lake-manifest.json" ]; then
 fi
 
 # Check if the repository is private
-if [ $private == "true" ]; then
+if [ "$private" == "true" ]; then
   echo "Package is ineligible for Reservoir because the repository is private."
   exit_code=1
 fi
 
 # Check if the repository has less than 2 stars
-if [ $number_of_stars -lt 2 ]; then
+if [ "$number_of_stars" -lt 2 ]; then
   echo "Package is ineligible for Reservoir because the repository has less than 2 stars."
   exit_code=1
 fi

diff --git a/scripts/install_elan.sh b/scripts/install_elan.sh
@@ -3,4 +3,4 @@
 set -o pipefail
 curl -sSfL https://github.com/leanprover/elan/releases/download/v1.4.2/elan-x86_64-unknown-linux-gnu.tar.gz | tar xz
 ./elan-init -y --default-toolchain none
-echo "$HOME/.elan/bin" >> $GITHUB_PATH
+echo "$HOME/.elan/bin" >> "$GITHUB_PATH"