LibraryBuild.yml

# LibraryBuild.yml
# Github workflow script to test compile all examples of an Arduino library repository.
#
# Copyright (C) 2020  Armin Joachimsmeyer
# https://github.com/ArminJo/Github-Actions
#
# Before being able to push to my .github\workflows directories,
# I had to create a new personal token with workflow enabled at https://github.com/settings/tokens

# This is the name of the workflow, visible on GitHub UI.
name: LibraryBuild
on:  
  push: # see: https://help.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-event-pull_request
    paths:
    - '**.ino'
    - '**.cpp'
    - '**.h'
    - '**LibraryBuild.yml'
  pull_request:
    paths:
    - '**.ino'
    - '**.cpp'
    - '**.h'
    - '**LibraryBuild.yml'

jobs:
  build:
    name: ${{ matrix.arduino-boards-fqbn }} - test compiling examples

    runs-on: ubuntu-18.04 # I picked Ubuntu to use shell scripts.

    strategy:
      matrix:
        # The matrix will produce one job for each configuration parameter of type `arduino-boards-fqbn`
        # In the Arduino IDE, the fqbn is printed in the first line of the verbose output for compilation as parameter -fqbn=... for the "arduino-builder -dump-prefs" command
        #
        # Examples: arduino:avr:uno, arduino:avr:leonardo, arduino:avr:nano, arduino:avr:mega
        # arduino:sam:arduino_due_x, arduino:samd:arduino_zero_native"
        # ATTinyCore:avr:attinyx5:chip=85,clock=1internal, digistump:avr:digispark-tiny, digistump:avr:digispark-pro
        # STM32:stm32:GenF1:pnum=BLUEPILL_F103C8
        # esp8266:esp8266:huzzah:eesz=4M3M,xtal=80, esp32:esp32:featheresp32:FlashFreq=80
        # You may add a suffix behind the fqbn with "|" to specify one board for e.g. different compile options like arduino:avr:uno|trace
        #############################################################################################################
        arduino-boards-fqbn:
          - arduino:avr:uno
          - arduino:avr:uno|DEBUG
          - arduino:avr:uno|USE_NO_SEND_PWM
          - arduino:avr:uno|USE_OLD_DECODE
          - arduino:avr:uno|NO_LEGACY_COMPATIBILITY
          - arduino:avr:uno|SEND_PWM_BY_TIMER
          - arduino:avr:leonardo
          - arduino:megaavr:nona4809:mode=off
          - megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal
          - digistump:avr:digispark-tiny:clock=clock16
          - ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll
          - ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled
          - ATTinyCore:avr:attinyx8micr:LTO=enable,sketchclock=16external,pinmapping=mhtiny,millis=enabled  # ATtiny88 China clone board @16 MHz
          - TinyCore:avr:tiny32
          - arduino:samd:arduino_zero_native
          - MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os_flto,clock=8MHz_internal # ATmega128
          - esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80
          - esp32:esp32:featheresp32:FlashFreq=80
          - STM32:stm32:GenF1:pnum=BLUEPILL_F103C8
          - STM32:stm32:GenL0:pnum=THUNDERPACK_L072
          - stm32duino:STM32F1:genericSTM32F103C
          - SparkFun:avr:promicro
          - sandeepmistry:nRF5:BBCmicrobit

        # Specify parameters for each board.
        # With sketches-exclude you may exclude specific examples for a board. Use a comma separated list.
        #############################################################################################################
        include:
          - arduino-boards-fqbn: arduino:avr:uno
            sketches-exclude: IR2Keyboard

          - arduino-boards-fqbn: arduino:avr:uno|DEBUG
            sketches-exclude: IR2Keyboard
            build-properties: # the flags were put in compiler.cpp.extra_flags
              All: -DEBUG

          - arduino-boards-fqbn: arduino:avr:uno|USE_NO_SEND_PWM
            sketches-exclude: IR2Keyboard
            build-properties: # the flags were put in compiler.cpp.extra_flags
              All: -DUSE_NO_SEND_PWM

          - arduino-boards-fqbn: arduino:avr:uno|USE_OLD_DECODE
            sketches-exclude: IR2Keyboard
            build-properties: # the flags were put in compiler.cpp.extra_flags
              All: -DUSE_OLD_DECODE

          - arduino-boards-fqbn: arduino:avr:uno|NO_LEGACY_COMPATIBILITY
            sketches-exclude: IR2Keyboard
            build-properties: # the flags were put in compiler.cpp.extra_flags
              All: -DNO_LEGACY_COMPATIBILITY

          - arduino-boards-fqbn: arduino:avr:uno|SEND_PWM_BY_TIMER
            sketches-exclude: IR2Keyboard
            build-properties: # the flags were put in compiler.cpp.extra_flags
              All: -DSEND_PWM_BY_TIMER

          - arduino-boards-fqbn: arduino:megaavr:nona4809:mode=off
            sketches-exclude: MinimalReceiver,IRDispatcherDemo

          - arduino-boards-fqbn: arduino:samd:arduino_zero_native
            sketches-exclude: MinimalReceiver,IRDispatcherDemo

          - arduino-boards-fqbn: megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal
            platform-url: http://drazzy.com/package_drazzy.com_index.json
            sketches-exclude: MinimalReceiver,IRDispatcherDemo # digitalWriteFast.h not available for this board

          - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock16
            platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
            required-libraries: ATtinySerialOut
            sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino

          - arduino-boards-fqbn: ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll
            platform-url: http://drazzy.com/package_drazzy.com_index.json
            required-libraries: ATtinySerialOut
            sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino

          - arduino-boards-fqbn: ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled
            platform-url: http://drazzy.com/package_drazzy.com_index.json
            required-libraries: ATtinySerialOut
            sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino

          - arduino-boards-fqbn: ATTinyCore:avr:attinyx8micr:LTO=enable,sketchclock=16external,pinmapping=mhtiny,millis=enabled  # ATtiny88 China clone board @16 MHz
            platform-url: http://drazzy.com/package_drazzy.com_index.json
            required-libraries: ATtinySerialOut
            sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino

          - arduino-boards-fqbn: TinyCore:avr:tiny32
            platform-url: https://raw.githubusercontent.com/xukangmin/TinyCore/master/avr/package/package_tinycore_index.json

          - arduino-boards-fqbn: MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os_flto,clock=8MHz_internal
            platform-url: https://mcudude.github.io/MegaCore/package_MCUdude_MegaCore_index.json
            arduino-platform: arduino:avr,MegaCore:avr # gcc is taken from arduino:avr
            sketches-exclude: MinimalReceiver,IRDispatcherDemo # digitalWriteFast.h not available for this board?

          - arduino-boards-fqbn: esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80
            platform-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json
            sketches-exclude: MinimalReceiver

          - arduino-boards-fqbn: esp32:esp32:featheresp32:FlashFreq=80
            platform-url: https://dl.espressif.com/dl/package_esp32_index.json
            sketches-exclude: MinimalReceiver # undefined reference to `TwoWire::onReceive(void (*)(int))'

          - arduino-boards-fqbn: STM32:stm32:GenF1:pnum=BLUEPILL_F103C8 # ST version
            platform-url: https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json
            sketches-exclude: MinimalReceiver

          - arduino-boards-fqbn: STM32:stm32:GenL0:pnum=THUNDERPACK_L072 # ST version
            platform-url: https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json
            sketches-exclude: MinimalReceiver,IRDispatcherDemo

          - arduino-boards-fqbn: stm32duino:STM32F1:genericSTM32F103C # Roger Clark version
            platform-url: http://dan.drown.org/stm32duino/package_STM32duino_index.json
            sketches-exclude: MinimalReceiver

          - arduino-boards-fqbn: SparkFun:avr:promicro
            arduino-platform: arduino:avr,SparkFun:avr
            platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json # Arduino URL is not required here

          - arduino-boards-fqbn: sandeepmistry:nRF5:BBCmicrobit
            platform-url: https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json
            sketches-exclude: IRDispatcherDemo,MicroGirs,MinimalReceiver # no tone()

      # Do not cancel all jobs / architectures if one job fails
      fail-fast: false

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

      - name: Compile all examples using the arduino-test-compile action
        uses: ArminJo/arduino-test-compile@master
        with:
          arduino-board-fqbn: ${{ matrix.arduino-boards-fqbn }}
          arduino-platform: ${{ matrix.arduino-platform }}
          platform-url: ${{ matrix.platform-url }}
          required-libraries: ${{ matrix.required-libraries }}
          sketch-names: ${{ matrix.sketch-names }}
          sketches-exclude: ${{ matrix.sketches-exclude }}
          build-properties: ${{ toJson(matrix.build-properties) }}