Merge pull request #2 from arduino-libraries/aliphys/CompileWorkflowTest

[AE-170] Ensure that the `compile-sketches.yml` workflow works for sketches

Author: alrvid

.github/workflows/compile-examples.yml

@@ -1,52 +1,96 @@
+# Source: https://github.com/per1234/.github/blob/main/workflow-templates/compile-examples-private.md
 name: Compile Examples
 
-on: 
+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+on:
   push:
-    branches: [main]
+    paths:
+      - ".github/workflows/compile-examples-private.ya?ml"
+      - "library.properties"
+      - "examples/**"
+      - "src/**"
   pull_request:
-    branches: [main]
-  # Scheduled trigger checks for breakage caused by changes to external resources (libraries, platforms)
+    paths:
+      - ".github/workflows/compile-examples-private.ya?ml"
+      - "library.properties"
+      - "examples/**"
+      - "src/**"
   schedule:
-    # run every Tuesday at 3 AM UTC
-    - cron: "0 3 * * 2"
-  # workflow_dispatch event allows the workflow to be triggered manually
-  # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
+    # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms).
+    - cron: "0 8 * * TUE"
   workflow_dispatch:
-  # repository_dispatch event allows the workflow to be triggered via the GitHub API
-  # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch
   repository_dispatch:
 
 env:
   SKETCHES_REPORTS_PATH: sketches-reports
   SKETCHES_REPORTS_ARTIFACT_NAME: sketches-reports
 
 jobs:
-  compile-examples:
+  build:
+    name: ${{ matrix.board.fqbn }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        board:
+          - fqbn: arduino:mbed_portenta:envie_m7
+            type: arduino:mbed_portenta
+          - fqbn: arduino:renesas_portenta:portenta_c33
+            type: renesas_portenta
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      - name: Compile example sketches
+      - name: Compile examples
         uses: arduino/compile-sketches@v1
         with:
-          fqbn: arduino:mbed_portenta:envie_m7
-          platforms: |
-            - name: arduino:mbed_portenta
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          fqbn: ${{ matrix.board.fqbn }}
+          platforms: ${{ matrix.board.platforms }}
           libraries: |
+            # Install the library from the local path.
             - source-path: ./
-            - name: Arduino_POSIXStorage
+            - name: Arduino_USBHostMbed5
+            # Additional library dependencies can be listed here.
+            # See: https://github.com/arduino/compile-sketches#libraries
           sketch-paths: |
-            - examples            
+            - examples
           enable-deltas-report: true
-          enable-warnings-report: true
           sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
-          github-token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Save memory usage change report as artifact
+      - name: Save sketches report as workflow artifact
         uses: actions/upload-artifact@v3
         with:
           if-no-files-found: error
           path: ${{ env.SKETCHES_REPORTS_PATH }}
           name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }}
+
+  report-size-deltas:
+    needs: build
+    # Run even if some compilations failed.
+    if: always() && github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+
+    steps:
+      - name: Download sketches reports artifact
+        id: download-artifact
+        continue-on-error: true # If compilation failed for all boards then there are no artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }}
+          path: ${{ env.SKETCHES_REPORTS_PATH }}
+
+      - name: Comment size deltas report to PR
+        uses: arduino/report-size-deltas@v1
+        # If actions/download-artifact failed, there are no artifacts to report from.
+        if: steps.download-artifact.outcome == 'success'
+        with:
+          sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }}