From 7a6b39a1af31c175c7e999ac366f52b6a3efcba4 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <consulting@lxrobotics.com>
Date: Wed, 21 Feb 2024 06:58:53 +0100
Subject: [PATCH] Fix regression: report size delta size on PR. (#172)

The necessary steps have in fact been documented here: https://github.com/arduino/report-size-deltas/blob/main/docs/FAQ.md#workflow-triggered-by-pull_request-event but I have overlooked them when I fixed the upload issue. With this PR the size deltas are - once again - reported within the PR.
---
 .github/workflows/compile-examples.yml   | 27 ++++++++++++++++++++----
 .github/workflows/report-size-deltas.yml | 24 ---------------------
 .gitignore                               |  1 +
 3 files changed, 24 insertions(+), 28 deletions(-)
 delete mode 100644 .github/workflows/report-size-deltas.yml

diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml
index 0dd5ac7..d7a183e 100644
--- a/.github/workflows/compile-examples.yml
+++ b/.github/workflows/compile-examples.yml
@@ -18,14 +18,15 @@ on:
   workflow_dispatch:
   repository_dispatch:
 
+env:
+  # It's convenient to set variables for values used multiple times in the workflow.
+  SKETCHES_REPORTS_PATH: sketches-reports
+
 jobs:
-  build:
+  compile:
     name: ${{ matrix.board.fqbn }}
     runs-on: ubuntu-latest
 
-    env:
-      SKETCHES_REPORTS_PATH: sketches-reports
-
     strategy:
       fail-fast: false
 
@@ -61,3 +62,21 @@ jobs:
           if-no-files-found: error
           path: ${{ env.SKETCHES_REPORTS_PATH }}
           name: sketches-report-${{ matrix.board.artifact-name-suffix }}
+
+  # When using a matrix to compile for multiple boards, it's necessary to use a separate job for the deltas report
+  report:
+    needs: compile # Wait for the compile job to finish to get the data for the report
+    if: github.event_name == 'pull_request' # Only run the job when the workflow is triggered by a pull request
+    runs-on: ubuntu-latest
+
+    steps:
+      # This step is needed to get the size data produced by the compile jobs
+      - name: Download sketches reports artifacts
+        uses: actions/download-artifact@v4
+        with:
+          # All workflow artifacts will be downloaded to this location.
+          path: ${{ env.SKETCHES_REPORTS_PATH }}
+
+      - uses: arduino/report-size-deltas@v1
+        with:
+          sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }}
diff --git a/.github/workflows/report-size-deltas.yml b/.github/workflows/report-size-deltas.yml
deleted file mode 100644
index 652be5d..0000000
--- a/.github/workflows/report-size-deltas.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-name: Report Size Deltas
-
-# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
-on:
-  push:
-    paths:
-      - ".github/workflows/report-size-deltas.yml"
-  schedule:
-    # Run at the minimum interval allowed by GitHub Actions.
-    # Note: GitHub Actions periodically has outages which result in workflow failures.
-    # In this event, the workflows will start passing again once the service recovers.
-    - cron: "*/5 * * * *"
-  workflow_dispatch:
-  repository_dispatch:
-
-jobs:
-  report:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Comment size deltas reports to PRs
-        uses: arduino/report-size-deltas@v1
-        with:
-          # The name of the workflow artifact created by the sketch compilation workflow
-          sketches-reports-source: sketches-reports
diff --git a/.gitignore b/.gitignore
index 653acab..24a0007 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@ examples/node_test_server/node_modules/
 *.DS_Store
 */.DS_Store
 examples/.DS_Store
+.idea/