Description

The compile-examples workflow provides an easy and flexible way to build check a matrix of sketches and boards of Arduino cores and libraries. It is designed to be used in CI/CD pipelines, with minimal integration in the CI infra workflows.

It relies on the Arduino platform and library specifications to auto-discover the available boards and examples available in the asset by default.

The default auto-discovery matrix can be customized to consider exceptions via configuration YAML files.

It also supports the installation of the tools and source dependencies for multiple operating systems, which are necessary for compiling the sketches for the selected boards.

Implementation details

From a high level, the GitHub Action workflow implements the following functionality:

1. Get the matrix of boards and operating systems to compile the examples against.

2. Generate the package core (Arduino core only).

3. For each board and operating system combination a job is created which:

   1. Install the required tools and asset dependencies.

   2. Compile the relevant examples for the board sequentially.

Please, explore the compile-examples.yml file to find out more about the implementation details of the reusable workflow.