Proposal: Add MegaLinter and Cargo Clippy CI Cycle

.ci/config.json

@@ -13,7 +13,7 @@
       "probe": "303a:1001:60:55:F9:BF:A9:44",
       "labels": {
         "target": "esp32",
-	"board": "esp-rust-board"
+        "board": "esp-rust-board"
       }
     }
   ]

.github/rodbot.yaml

@@ -1,3 +1,4 @@
+---
 on:
   issue_comment:
     - if:

.github/workflows/ci.yaml

@@ -1,3 +1,4 @@
+---
 name: CI
 
 on:
@@ -11,14 +12,16 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      ENABLE_MEGALINTER: true
     steps:
       - uses: actions/checkout@v4
       - name: Add dependencies
         run: |
           sudo apt-get update
           sudo apt-get install --no-install-recommends libudev-dev
       - name: Set up cargo cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4.2.0
         continue-on-error: true
         with:
           path: |

.github/workflows/release_trouble_host.yaml

@@ -1,13 +1,14 @@
-name: Trouble Host Release 
+---
+name: Trouble Host Release
 
 on:
   push:
     tags:
-     - 'trouble-host-v[0-9]+.[0-9]+.[0-9]+'
+      - "trouble-host-v[0-9]+.[0-9]+.[0-9]+"
 
 permissions:
   contents: write
-  
+
 jobs:
   # Re Run the Checks
   build:
@@ -19,7 +20,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install --no-install-recommends libudev-dev
       - name: Set up cargo cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4.2.0
         continue-on-error: true
         with:
           path: |
@@ -43,48 +44,48 @@ jobs:
     timeout-minutes: 10
     if: github.ref == 'refs/heads/main'
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-    - name: Verify Version
-      run: |
-        TAG_VERSION=${GITHUB_REF#refs/tags/trouble-host-v}
-        CARGO_VERSION=$(grep '^version =' host/Cargo.toml | sed -E 's/version = "([^"]+)"/\1/')
-        if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
-          echo "Version mismatch: tag is $TAG_VERSION but Cargo.toml is $CARGO_VERSION"
-          exit 1  # Exits with a non-zero status to fail the workflow
-        fi
-      shell: bash
+      - name: Verify Version
+        run: |
+          TAG_VERSION=${GITHUB_REF#refs/tags/trouble-host-v}
+          CARGO_VERSION=$(grep '^version =' host/Cargo.toml | sed -E 's/version = "([^"]+)"/\1/')
+          if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
+            echo "Version mismatch: tag is $TAG_VERSION but Cargo.toml is $CARGO_VERSION"
+            exit 1  # Exits with a non-zero status to fail the workflow
+          fi
+        shell: bash
 
-    - name: Set up Rust
-      uses: dtolnay/rust-toolchain@stable
-      with:
-        toolchain: stable
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: stable
 
-    - name: Build project
-      run: |
-        cd host 
-        cargo build --release
-
-    - name: Create GitHub release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        tag: ${{ github.ref_name }}
-      run: |
-        gh release create "$tag" \
-            --repo="$GITHUB_REPOSITORY" \
-            --title="${GITHUB_REPOSITORY#*/} host v${tag#trouble-host-v}" \
-            --generate-notes
+      - name: Build project
+        run: |
+          cd host
+          cargo build --release
 
-    - name: Publish to crates.io
-      env:
-        CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
-      # Publish to the main registry
-      run: |
-        echo "Publishing to crates.io"  
-        cargo publish
-      # To perform a dry run uncomment the following lines
-      # run: |
-      #   echo "Performing dry-run publish to crates.io"
-      #   cd host
-      #   cargo publish --dry-run
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+        run: |
+          gh release create "$tag" \
+              --repo="$GITHUB_REPOSITORY" \
+              --title="${GITHUB_REPOSITORY#*/} host v${tag#trouble-host-v}" \
+              --generate-notes
+
+      - name: Publish to crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        # Publish to the main registry
+        run: |
+          echo "Publishing to crates.io"
+          cargo publish
+        # To perform a dry run uncomment the following lines
+        # run: |
+        #   echo "Performing dry-run publish to crates.io"
+        #   cd host
+        #   cargo publish --dry-run

.github/workflows/release_trouble_host_macros.yaml

@@ -1,13 +1,14 @@
+---
 name: Trouble Host macros Release
 
 on:
   push:
     tags:
-     - 'trouble-host-macros-v[0-9]+.[0-9]+.[0-9]+'
+      - "trouble-host-macros-v[0-9]+.[0-9]+.[0-9]+"
 
 permissions:
   contents: write
-  
+
 jobs:
   # Re Run the Checks
   build:
@@ -19,7 +20,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install --no-install-recommends libudev-dev
       - name: Set up cargo cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4.2.0
         continue-on-error: true
         with:
           path: |
@@ -43,48 +44,48 @@ jobs:
     timeout-minutes: 10
     if: github.ref == 'refs/heads/main'
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-    - name: Verify Version
-      run: |
-        TAG_VERSION=${GITHUB_REF#refs/tags/trouble-host-macros-v}
-        CARGO_VERSION=$(grep '^version =' host-macros/Cargo.toml | sed -E 's/version = "([^"]+)"/\1/')
-        if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
-          echo "Version mismatch: tag is $TAG_VERSION but Cargo.toml is $CARGO_VERSION"
-          exit 1  # Exits with a non-zero status to fail the workflow
-        fi
-      shell: bash
+      - name: Verify Version
+        run: |
+          TAG_VERSION=${GITHUB_REF#refs/tags/trouble-host-macros-v}
+          CARGO_VERSION=$(grep '^version =' host-macros/Cargo.toml | sed -E 's/version = "([^"]+)"/\1/')
+          if [ "$TAG_VERSION" != "$CARGO_VERSION" ]; then
+            echo "Version mismatch: tag is $TAG_VERSION but Cargo.toml is $CARGO_VERSION"
+            exit 1  # Exits with a non-zero status to fail the workflow
+          fi
+        shell: bash
 
-    - name: Set up Rust
-      uses: dtolnay/rust-toolchain@stable
-      with:
-        toolchain: stable
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: stable
 
-    - name: Build project
-      run: |
-        cd host-macros
-        cargo build --release
-
-    - name: Create GitHub release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        tag: ${{ github.ref_name }}
-      run: |
-        gh release create "$tag" \
-            --repo="$GITHUB_REPOSITORY" \
-            --title="${GITHUB_REPOSITORY#*/} host macros v${tag#trouble-host-macros-v}" \
-            --generate-notes
+      - name: Build project
+        run: |
+          cd host-macros
+          cargo build --release
 
-    - name: Publish to crates.io
-      env:
-        CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
-      # Publish to the main registry
-      run: |
-        echo "Publishing to crates.io"  
-        cargo publish
-      # To perform a dry run uncomment the following lines
-      # run: |
-      #   echo "Performing dry-run publish to crates.io"
-      #   cd host-macros
-      #   cargo publish --dry-run
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+        run: |
+          gh release create "$tag" \
+              --repo="$GITHUB_REPOSITORY" \
+              --title="${GITHUB_REPOSITORY#*/} host macros v${tag#trouble-host-macros-v}" \
+              --generate-notes
+
+      - name: Publish to crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        # Publish to the main registry
+        run: |
+          echo "Publishing to crates.io"
+          cargo publish
+        # To perform a dry run uncomment the following lines
+        # run: |
+        #   echo "Performing dry-run publish to crates.io"
+        #   cd host-macros
+        #   cargo publish --dry-run

.github/workflows/rodbot.yaml

@@ -1,8 +1,9 @@
+---
 name: rodbot
 
 on:
   issue_comment:
-    types: [ "created" ]
+    types: ["created"]
 
 jobs:
   rodbot:
@@ -13,11 +14,11 @@ jobs:
 
     steps:
       - run: |
-          echo $GITHUB_EVENT_PATH
-          cat $GITHUB_EVENT_PATH
+          echo $"GITHUB_EVENT_PATH"
+          cat $"GITHUB_EVENT_PATH"
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: ctron/[email protected]
         with:

.github/workflows/tests.yaml

@@ -1,3 +1,4 @@
+---
 name: Tests
 
 on:
@@ -23,7 +24,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install --no-install-recommends libudev-dev
       - name: Set up cargo cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4.2.0
         continue-on-error: true
         with:
           path: |
@@ -62,7 +63,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           gh api --method POST -H "Accept: application/vnd.github+json" \
-            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/${COMMIT} \
+            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/"${COMMIT}" \
             -f "state=pending" -f "description=Running integration tests" -f "context=integration-tests"
       - name: Test
         env:
@@ -78,7 +79,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           gh api --method POST -H "Accept: application/vnd.github+json" \
-            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/${COMMIT} \
+            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/"${COMMIT}" \
             -f "state=failure" -f "description=The integration tests failed" -f "context=integration-tests"
       - name: Update success status
         if: success()
@@ -87,7 +88,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           gh api --method POST -H "Accept: application/vnd.github+json" \
-            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/${COMMIT} \
+            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/"${COMMIT}" \
             -f "state=success" -f "description=The integration tests succeeded!" -f "context=integration-tests"
 
   example-tests:
@@ -108,7 +109,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           gh api --method POST -H "Accept: application/vnd.github+json" \
-            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/${COMMIT} \
+            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/"${COMMIT}" \
             -f "state=pending" -f "description=Running example tests" -f "context=example-tests"
 
       - uses: actions/download-artifact@v4
@@ -131,7 +132,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           gh api --method POST -H "Accept: application/vnd.github+json" \
-            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/${COMMIT} \
+            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/"${COMMIT}" \
             -f "state=failure" -f "description=The example tests failed" -f "context=example-tests"
       - name: Update success status
         if: success()
@@ -140,5 +141,5 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           gh api --method POST -H "Accept: application/vnd.github+json" \
-            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/${COMMIT} \
+            -H "X-GitHub-Api-Version: 2022-11-28" /repos/embassy-rs/trouble/statuses/"${COMMIT}" \
             -f "state=success" -f "description=The example tests succeeded!" -f "context=example-tests"

.gitignore

@@ -1,4 +1,7 @@
 **/target
 **/target_ci
 Cargo.lock
-.idea
+.idea
+megalinter-reports/
+# Mac Users
+.DS_Store

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+  "default": true,
+  "line-length": false
+}