ci(GitHub): Add Super-Linter job

oboukli · Jun 8, 2023 · b44b2c6 · b44b2c6
1 parent 765ffe1
commit b44b2c6
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 20 deletions.
diff --git a/.github/workflows/emscripten-build.yml b/.github/workflows/emscripten-build.yml
@@ -37,8 +37,8 @@ jobs:
         env:
           EMSDK_VERSION: 3.1.40
         run: |-
-          ./emsdk install ${EMSDK_VERSION}
-          ./emsdk activate ${EMSDK_VERSION}
+          ./emsdk install "${EMSDK_VERSION}"
+          ./emsdk activate "${EMSDK_VERSION}"
         working-directory: emsdk
 
       - name: Check out main repository
@@ -53,7 +53,7 @@ jobs:
         working-directory: tromino-puzzle/emscripten
 
       - name: Archive files
-        run: tar --create --file=dist.tar *
+        run: tar --create --file=dist.tar -- *
         working-directory: tromino-puzzle/dist/web
 
       - name: Archive web app artifacts
@@ -76,7 +76,7 @@ jobs:
           ref: gh-pages
 
       - name: Remove current files
-        run: rm -rf *
+        run: rm -rf -- *
 
       - name: Download build artifact
         uses: actions/download-artifact@v3

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -4,13 +4,9 @@ on:
   pull_request:
     branches:
       - main
-    paths:
-      - "**.md"
   push:
     branches:
       - main
-    paths:
-      - "**.md"
   workflow_dispatch:
 
 permissions:
@@ -30,3 +26,23 @@ jobs:
 
       - name: Run markdownlint
         run: markdownlint .
+
+  superlinter:
+    name: Super-Linter
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Run Super-Linter
+        uses: github/super-linter/slim@v4
+        env:
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          HTML_FILE_NAME: ${{ github.workspace }}/.htmlhintrc
+          VALIDATE_ALL_CODEBASE: true
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          VALIDATE_JSCPD: false
diff --git a/.github/workflows/sonarcloud.yml b/.github/workflows/sonarcloud.yml
@@ -63,18 +63,18 @@ jobs:
         env:
           SONAR_SCANNER_DOWNLOAD_URL: https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${{ env.SONAR_SCANNER_VERSION }}-linux.zip
         run: >-
-          mkdir --parents $HOME/.sonar
+          mkdir --parents "$HOME/.sonar"
 
           curl
           --silent
           --show-error
           --location
-          --output $HOME/.sonar/sonar-scanner.zip
-          ${{ env.SONAR_SCANNER_DOWNLOAD_URL }}
+          --output "$HOME/.sonar/sonar-scanner.zip"
+          "${{ env.SONAR_SCANNER_DOWNLOAD_URL }}"
 
           unzip
-          -o $HOME/.sonar/sonar-scanner.zip
-          -d $HOME/.sonar/
+          -o "$HOME/.sonar/sonar-scanner.zip"
+          -d "$HOME/.sonar/"
 
           echo "$HOME/.sonar/sonar-scanner-${{ env.SONAR_SCANNER_VERSION }}-linux/bin"
           >> $GITHUB_PATH
@@ -87,12 +87,12 @@ jobs:
           --silent
           --show-error
           --location
-          --output $HOME/.sonar/build-wrapper-linux-x86.zip
-          ${{ env.BUILD_WRAPPER_DOWNLOAD_URL }}
+          --output "$HOME/.sonar/build-wrapper-linux-x86.zip"
+          "${{ env.BUILD_WRAPPER_DOWNLOAD_URL }}"
 
           unzip
-          -o $HOME/.sonar/build-wrapper-linux-x86.zip
-          -d $HOME/.sonar/
+          -o "$HOME/.sonar/build-wrapper-linux-x86.zip"
+          -d "$HOME/.sonar/"
 
           echo "$HOME/.sonar/build-wrapper-linux-x86"
           >> $GITHUB_PATH
@@ -104,7 +104,7 @@ jobs:
           ./configure --enable-code-coverage CPPFLAGS=-DTROMINO_2D_HEADLESS
 
           build-wrapper-linux-x86-64
-          --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }}
+          --out-dir "${{ env.BUILD_WRAPPER_OUT_DIR }}"
           make clean all check
 
       - name: Run tromino
@@ -137,7 +137,7 @@ jobs:
           --exclude=/usr/include
           --keep
           --root .
-          --sonarqube ${{ env.COVERAGE_REPORTS_PATH }}
+          --sonarqube "${{ env.COVERAGE_REPORTS_PATH }}"
 
       - name: Run sonar-scanner
         env:

diff --git a/.github/workflows/windows-build.yml b/.github/workflows/windows-build.yml
@@ -75,4 +75,4 @@ jobs:
           -property:Platform=${{ env.BUILD_PLATFORM }}
           -validate
           -warnAsError
-          ${{ env.SOLUTION_FILE_PATH }}
+          "${{ env.SOLUTION_FILE_PATH }}"
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=oboukli_tromino-puzzle&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=oboukli_tromino-puzzle)
 [![CodeFactor](https://www.codefactor.io/repository/github/oboukli/tromino-puzzle/badge)](https://www.codefactor.io/repository/github/oboukli/tromino-puzzle)
 [![Codacy](https://app.codacy.com/project/badge/Grade/8395b4fbd3b34c72907b0e65fe0b5f35)](https://www.codacy.com/gh/oboukli/tromino-puzzle/dashboard)
+[![GitHub Super-Linter](https://github.com/oboukli/tromino-puzzle/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
 
 This is a C library (see `src/libtromino`) implementing a divide-and-conquer O(n)
 algorithm, and a collection of apps, to solve the tromino puzzle,