Add linters to CI pipeline

.github/workflows/publishBranchesPRs.yml

@@ -5,7 +5,7 @@ name: PR - Create and publish a Docker image
 on:
   pull_request:
   #push:
-  #  branches: 
+  #  branches:
   #    - '*'
   #    - '!master'
 
@@ -22,7 +22,7 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # 
+      #
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
@@ -36,7 +36,7 @@ jobs:
       # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
       - name: Extract branch name
         shell: bash
-        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> "$GITHUB_OUTPUT"
         id: extract_branch
       - name: Extract metadata (tags, labels) for Docker
         id: meta

.github/workflows/publishMaster.yml

@@ -4,7 +4,7 @@ name: Master - Create and publish a Docker image
 # Configures this workflow to run every time a change is pushed to the branch called `master`.
 on:
   push:
-    branches: ['master']
+    branches: ["master"]
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -19,7 +19,7 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # 
+      #
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3

.github/workflows/publishTags.yml

@@ -4,8 +4,8 @@ name: Tags - Create and publish a Docker image
 # Build when a tag is created
 on:
   push:
-    tags:        
-      - '**'
+    tags:
+      - "**"
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
@@ -20,7 +20,7 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # 
+      #
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3

.github/workflows/superLinter.yml

@@ -0,0 +1,42 @@
+---
+# This workflow executes several linters on changed files based on languages used in your code base whenever
+# you push a code or open a pull request.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/github/super-linter
+name: Lint Code Base
+
+on: # yamllint disable-line rule:truthy
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  run-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v7
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_EDITORCONFIG: false
+          VALIDATE_JSCPD: false
+          VALIDATE_MARKDOWN: false
+          VALIDATE_PHP: false
+          VALIDATE_PYTHON: true
+          VALIDATE_YAML: false
+          VALIDATE_YAML_PRETTIER: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LINTER_RULES_PATH: /
+          DOCKERFILE_HADOLINT_LINTER_RULES: .hadolint.yml
+          MARKDOWN_CONFIG_FILE: .markdown-lint.yml
+          YAML_LINTER_RULES: .yamllint.yml

.hadolint.yml

@@ -0,0 +1,3 @@
+ignored:
+  - DL3008  # Pin versions in apt get install. Instead of `apt-get install <package>` use `apt-get install <package>=<version>`
+  - DL3018  # Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`

.yamllint.yml

@@ -0,0 +1,11 @@
+extends: default
+
+rules:
+  document-start: disable
+  line-length:
+    max: 180
+    level: warning
+  comments:
+    # Changed this to stop a mess between linters from Prettier (vscode) to yamllint
+    # - https://github.com/prettier/prettier/pull/10926
+    min-spaces-from-content: 1

Dockerfile

@@ -36,8 +36,8 @@ RUN cd /tmp && \
   dpkg -i /tmp/brscan-skey-0.3.1-2.amd64.deb && \
   rm /tmp/brscan-skey-0.3.1-2.amd64.deb
 
-ADD files/runScanner.sh /opt/brother/runScanner.sh
-ADD files/brscan-skey.config /opt/brother/scanner/brscan-skey/brscan-skey.config
+COPY files/runScanner.sh /opt/brother/runScanner.sh
+COPY files/brscan-skey.config /opt/brother/scanner/brscan-skey/brscan-skey.config
 COPY script /opt/brother/scanner/brscan-skey/script
 
 RUN cp /etc/lighttpd/conf-available/05-auth.conf /etc/lighttpd/conf-enabled/