compile-examples.yml

name: Compile Examples

on:
  pull_request:
    paths:
      - ".github/workflows/compile-examples.yml"
      - "examples/**"
      - "src/**"
  push:
    paths:
      - ".github/workflows/compile-examples.yml"
      - "examples/**"
      - "src/**"

jobs:
  build:
    runs-on: ubuntu-latest

    env:
      # libraries to install for all boards
      UNIVERSAL_LIBRARIES: |
        # Install the ArduinoIoTCloud library from the repository
        - source-path: ./
        - source-url: https://github.com/fabik111/Arduino_ConnectionHandler.git
          version: 0314cf54593029aea05bb8c179e40a26128f7d67
        - name: ArduinoBLE
        - name: ArduinoHttpClient
        - name: Arduino_DebugUtils
        - name: ArduinoMqttClient
        - source-url: https://github.com/fabik111/Arduino_SecureElement.git
          version: f5a23964a1c70048e48d5ed2d2657004446f0e3d
        - source-url: https://github.com/fabik111/Arduino_CloudUtils.git
          version: a8b52eaf500c63b2e8bd3e4b6f6c77b70fc3e65d
        - source-url: https://github.com/arduino-libraries/Arduino_KVStore.git
        - source-url: https://github.com/arduino-libraries/Arduino_UniqueHWId.git
        - source-url: https://github.com/arduino-libraries/Arduino_NetworkConfigurator.git
      # sketch paths to compile (recursive) for all boards
      UNIVERSAL_SKETCH_PATHS: |
        - examples/ArduinoIoTCloud-Advanced
        - examples/ArduinoIoTCloud-Basic
        - examples/ArduinoIoTCloud-Callbacks
        - examples/utility/ArduinoIoTCloud_Travis_CI
      SKETCHES_REPORTS_PATH: sketches-reports

    strategy:
      fail-fast: false

      matrix:
        board:
          - fqbn: arduino:samd:mkr1000
            type: mkr1000
            artifact-name-suffix: arduino-samd-mkr1000
          - fqbn: arduino:samd:mkrwifi1010
            type: nina
            artifact-name-suffix: arduino-samd-mkrwifi1010
          - fqbn: arduino:samd:nano_33_iot
            type: nina
            artifact-name-suffix: arduino-samd-nano_33_iot
          - fqbn: arduino:samd:mkrwan1300
            type: wan
            artifact-name-suffix: arduino-samd-mkrwan1300
          - fqbn: arduino:samd:mkrgsm1400
            type: gsm
            artifact-name-suffix: arduino-samd-mkrgsm1400
          - fqbn: arduino:samd:mkrnb1500
            type: nb
            artifact-name-suffix: arduino-samd-mkrnb1500
          - fqbn: arduino:mbed_portenta:envie_m7
            type: mbed_portenta
            artifact-name-suffix: arduino-mbed_portenta-envie_m7
          - fqbn: esp8266:esp8266:huzzah
            type: esp8266
            artifact-name-suffix: esp8266-esp8266-huzzah
          - fqbn: esp32:esp32:esp32
            type: esp32
            artifact-name-suffix: esp32-esp32-esp32
          - fqbn: arduino:mbed_nano:nanorp2040connect
            type: nina
            artifact-name-suffix: arduino-mbed_nano-nanorp2040connect
          - fqbn: arduino:mbed_nicla:nicla_vision
            type: mbed_nicla
            artifact-name-suffix: arduino-mbed_nicla-nicla_vision
          - fqbn: arduino:mbed_opta:opta
            type: mbed_opta
            artifact-name-suffix: arduino-mbed_opta-opta
          - fqbn: arduino:mbed_giga:giga
            type: mbed_giga
            artifact-name-suffix: arduino-mbed_giga-giga
          - fqbn: arduino:renesas_portenta:portenta_c33
            type: renesas_portenta
            artifact-name-suffix: arduino-renesas_portenta-portenta_c33
          - fqbn: arduino:renesas_uno:unor4wifi
            type: renesas_uno
            artifact-name-suffix: arduino-renesas_uno-unor4wifi
          - fqbn: arduino:esp32:nano_nora
            type: arduino_esp32
            artifact-name-suffix: arduino-esp32-nano_nora
          - fqbn: arduino:mbed_edge:edge_control
            type: mbed_edge
            artifact-name-suffix: arduino-mbed_edge-edge_control
          - fqbn: "rp2040:rp2040:rpipicow"
            type: rp2040
            artifact-name-suffix: rp2040-rp2040-rpipicow


        # make board type-specific customizations to the matrix jobs
        include:
          # MKR 1000
          - board:
              type: mkr1000
            platforms: |
              # Install samd platform via Boards Manager
              - name: arduino:samd
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
              - name: RTCZero
              - name: WiFi101
              - source-url: https://github.com/adafruit/Adafruit_SleepyDog.git
            sketch-paths: |
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
          # MKR WiFi 1010, Nano 33 IoT, Nano RP2040 Connect
          - board:
              type: nina
            platforms: |
              # Install samd and mbed_nano platform via Boards Manager
              - name: arduino:samd
              - name: arduino:mbed_nano
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
              - name: RTCZero
              - source-url: https://github.com/andreagilardoni/WiFiNINA.git
                version: 31616ac5a30f6281c68f982bc39800771b2fbaeb
              - name: Arduino_JSON
              - source-url: https://github.com/adafruit/Adafruit_SleepyDog.git
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
              - examples/utility/SelfProvisioning
              - examples/utility/Provisioning_2.0
          - board:
              type: wan
            platforms: |
              # Install samd platform via Boards Manager
              - name: arduino:samd
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
              - name: RTCZero
              - name: MKRWAN
              - source-url: https://github.com/adafruit/Adafruit_SleepyDog.git
            sketch-paths: |
              - examples/ArduinoIoTCloud-Notecard
          # GSM boards
          - board:
              type: gsm
            platforms: |
              # Install samd platform via Boards Manager
              - name: arduino:samd
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
              - name: RTCZero
              - name: MKRGSM
              - source-url: https://github.com/adafruit/Adafruit_SleepyDog.git
            sketch-paths: |
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
          # NB boards
          - board:
              type: nb
            platforms: |
              # Install samd platform via Boards Manager
              - name: arduino:samd
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
              - name: RTCZero
              - name: MKRNB
              - source-url: https://github.com/adafruit/Adafruit_SleepyDog.git
            sketch-paths: |
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
          # Portenta
          - board:
              type: mbed_portenta
            platforms: |
              # Install mbed_portenta platform via Boards Manager
              - name: arduino:mbed_portenta
            libraries: |
              - name: ArduinoECCX08
              - name: Arduino_Cellular
              - name: Blues Wireless Notecard
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
              - examples/utility/Provisioning_2.0
          # Nicla Vision
          - board:
              type: mbed_nicla
            platforms: |
              # Install mbed_nicla platform via Boards Manager
              - name: arduino:mbed_nicla
            libraries: |
              - name: Blues Wireless Notecard
              - name: ArduinoECCX08
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
              - examples/utility/Provisioning_2.0
          # Opta
          - board:
              type: mbed_opta
            platforms: |
              # Install mbed_opta platform via Boards Manager
              - name: arduino:mbed_opta
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
              - examples/utility/Provisioning_2.0
          # GIGA
          - board:
              type: mbed_giga
            platforms: |
              # Install mbed_giga platform via Boards Manager
              - name: arduino:mbed_giga
            libraries: |
              - name: ArduinoECCX08
              - name: Blues Wireless Notecard
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
              - examples/utility/Provisioning_2.0
          # Portenta C33
          - board:
              type: renesas_portenta
            platforms: |
              # Install renesas_portenta platform via Boards Manager
              - name: arduino:renesas_portenta
            libraries: |
              - name: Arduino_Cellular
              - name: Blues Wireless Notecard
              - name: ArduinoECCX08
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning
              - examples/utility/Provisioning_2.0
          # UNO R4 WiFi
          - board:
              type: renesas_uno
            platforms: |
              # Install renesas_uno platform via Boards Manager
              - name: arduino:renesas_uno
            libraries: |
              - name: Blues Wireless Notecard
              - name: ArduinoECCX08
            sketch-paths: |
              - examples/ArduinoIoTCloud-NetConfig
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
              - examples/utility/Provisioning_2.0
          # Nano ESP32
          - board:
              type: arduino_esp32
            platforms: |
              # Install arduino_esp32 platform via Boards Manager
              - name: arduino:esp32
            libraries: |
              - name: Blues Wireless Notecard
            sketch-paths: |
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
          # Edge Control
          - board:
              type: mbed_edge
            platforms: |
              # Install mbed_edge platform via Boards Manager
              - name: arduino:mbed_edge
            libraries: |
              - name: Blues Wireless Notecard
            sketch-paths: |
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
          # ESP8266 boards
          - board:
              type: esp8266
            platforms: |
              # Install ESP8266 platform via Boards Manager
              - name: esp8266:esp8266
                source-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json
                # Use the version currently installed in Arduino Cloud
                version: 2.5.0
            libraries:
            sketch-paths: |
              - examples/ArduinoIoTCloud-Schedule
          # ESP32 boards
          - board:
              type: esp32
            platforms: |
              # Install ESP32 platform via Boards Manager
              - name: esp32:esp32
                source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
            libraries: |
              - name: Blues Wireless Notecard
            sketch-paths: |
              - examples/ArduinoIoTCloud-DeferredOTA
              - examples/ArduinoIoTCloud-Notecard
              - examples/ArduinoIoTCloud-Schedule
          # PicoW
          - board:
              type: rp2040
            platforms: |
              # Install rp2040 platform via Boards Manager
              - name: rp2040:rp2040
                source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install ESP32 platform dependencies
        if: matrix.board.type == 'esp32'
        run: pip3 install pyserial

      - name: Compile examples
        uses: arduino/compile-sketches@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          platforms: ${{ matrix.platforms }}
          fqbn: ${{ matrix.board.fqbn }}
          libraries: |
            ${{ env.UNIVERSAL_LIBRARIES }}
            ${{ matrix.libraries }}
          sketch-paths: |
            ${{ env.UNIVERSAL_SKETCH_PATHS }}
            ${{ matrix.sketch-paths }}
          enable-deltas-report: "true"
          sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
          cli-compile-flags: |
            - --output-dir
            - ${{ runner.temp }}/arduino-cli-output

      - name: Write data to size trends report spreadsheet
        # Update report on every push to the master branch
        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
        uses: arduino/report-size-trends@main
        with:
          sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
          google-key-file: ${{ secrets.GOOGLE_KEY_FILE }}
          spreadsheet-id: 1I6NZkpZpf8KugBkE92adB1Z3_b7ZepOpCdYTOigJpN4

      - name: Save memory usage change report as artifact
        if: github.event_name == 'pull_request'
        uses: actions/upload-artifact@v4
        with:
          name: sketches-report-${{ matrix.board.artifact-name-suffix }}
          path: ${{ env.SKETCHES_REPORTS_PATH }}

      - name: Save build artifact
        if: github.event_name == 'pull_request'
        uses: actions/upload-artifact@v4
        with:
          name: provisioning-${{ matrix.board.artifact-name-suffix }}
          path: ${{ runner.temp }}/arduino-cli-output/Provisioning_2.0*