Add build_examples.sh script

Author: mlesniew

.github/workflows/ci.yml

@@ -34,16 +34,9 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: '3.9'
+      - name: Install jq
+        run: sudo apt-get install -yq jq
       - name: Install PlatformIO Core
         run: pip install --upgrade platformio
       - name: Build examples
-        run: |
-          for example in examples/*; do
-            cd "$example"
-            platformio init --board ${{ matrix.board }}
-            grep -q ArduinoJson *.ino && echo "lib_deps = bblanchon/ArduinoJson" >> platformio.ini
-            mv *.ino src/
-            ln -s ../../../ lib/PicoMQTT
-            pio run
-            cd ../..
-          done
+        run: ./build_examples.sh ${{ matrix.board }}

.gitignore

@@ -1,4 +1,5 @@
 .pio
 *.orig
 *.tar.gz
-*.sh
+/examples.build
+/config.h

build_examples.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+if [ "$#" -ne 1 ]
+then
+	echo "Usage: $0 <pio-board-name>"
+	exit 1
+fi
+
+set -e
+
+cd "$(dirname "$0")"
+
+mkdir -p examples.build
+ROOT_DIR=$PWD
+
+BOARD="$1"
+PLATFORM="$(pio boards --json-output | jq -r ".[] | select(.id == \"$BOARD\") | .platform")"
+
+if [ -z "$PLATFORM" ]
+then
+	echo "Unknown board $BOARD"
+	exit 2
+fi
+
+find examples -mindepth 1 -type d | cut -d/ -f2 | sort | while read -r EXAMPLE
+do
+	COMPATIBLE_PLATFORMS="$(grep -hoiE 'platform compatibility:.*' "$ROOT_DIR/examples/$EXAMPLE/"* | cut -d: -f2- | head -n1)"
+	DEPENDENCIES="$(grep -hoiE 'dependencies:.*' "$ROOT_DIR/examples/$EXAMPLE/"* | cut -d: -f2- | head -n1)"
+	echo "$EXAMPLE:$COMPATIBLE_PLATFORMS"
+	if [ -n "$COMPATIBLE_PLATFORMS" ] && ! echo "$COMPATIBLE_PLATFORMS" | grep -qFiw "$PLATFORM"
+	then
+		echo "$EXAMPLE: This example is not compatible with this platform"
+		continue
+	fi
+
+	mkdir -p examples.build/$BOARD/$EXAMPLE
+	pushd examples.build/$BOARD/$EXAMPLE
+	if [ ! -f platformio.ini ]
+	then
+		pio init --board=$BOARD
+		echo "monitor_speed = 115200" >> platformio.ini
+		echo "upload_speed = 921600"  >> platformio.ini
+		if [ -n "$DEPENDENCIES" ]
+		then
+			echo "lib_deps = $DEPENDENCIES" >> platformio.ini
+		fi
+	fi
+	ln -s -f -t src/ "$ROOT_DIR/examples/$EXAMPLE/"*
+	ln -s -f -t lib/ "$ROOT_DIR"
+	if [ -e "$ROOT_DIR/config.h" ]
+	then
+		ln -s -f -t src/ "$ROOT_DIR/config.h"
+	fi
+	pio run
+	popd
+done

examples/arduinojson/arduinojson.ino

@@ -1,3 +1,4 @@
+// dependencies: bblanchon/ArduinoJson
 #include <PicoMQTT.h>
 
 #if __has_include("config.h")