GH Workflow: publish clippy results

this will show the results directly on the PR rather than having to check the log of the action.
rust-embedded-community · Dec 13, 2023 · a4b6b8d · a4b6b8d
1 parent 1a0fdb5
commit a4b6b8d
Showing 1 changed file with 27 additions and 5 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -1,5 +1,8 @@
 name: CI
 
+permissions:
+  security-events: write # needed to upload SARIF reports on branch builds
+
 on:
   push:
     branches: [ "master" ]
@@ -20,6 +23,8 @@ jobs:
         with:
           toolchain: ${{ matrix.rust }}
           components: rustfmt clippy
+      - name: Install required cargo components
+        run: cargo install clippy-sarif sarif-fmt
       - name: build
         run: cargo build --features ${{ matrix.features }}
       - name: check
@@ -28,10 +33,16 @@ jobs:
         run: cargo test --features ${{ matrix.features }}
       - name: check formatting
         run: cargo fmt --all -- --check
-      - name: clippy
-        run: cargo clippy --features ${{ matrix.features }}
       - name: audit
         run: cargo audit
+      - name: clippy (lib)
+        run: cargo clippy --features ${{ matrix.features }} --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
+        continue-on-error: true
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: rust-clippy-results.sarif
+          wait-for-processing: true
 
   stm32f4-event-printer:
     runs-on: ubuntu-latest
@@ -54,9 +65,20 @@ jobs:
       - name: check formatting
         run: cargo fmt --all -- --check
         working-directory: examples/stm32f4-event-printer
-      - name: clippy
-        run: cargo clippy
-        working-directory: examples/stm32f4-event-printer
       - name: audit
         run: cargo audit
         working-directory: examples/stm32f4-event-printer
+      - name: clippy (example)
+        # see the following comment for the patching workaround: https://github.com/psastras/sarif-rs/issues/370#issuecomment-1475364427
+        run: |
+          cargo clippy --message-format=json | \
+          clippy-sarif | \
+          jq --arg pwd "examples/stm32f4-event-printer" '.runs[].results[].locations[].physicalLocation.artifactLocation.uri |= $pwd + "/" + .' | \
+          tee rust-clippy-results.sarif | \
+          sarif-fmt
+        working-directory: examples/stm32f4-event-printer
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: examples/stm32f4-event-printer/rust-clippy-results.sarif
+          wait-for-processing: true