Add CI for book examples.

Author: davidchisnall

.github/workflows/main.yml

@@ -0,0 +1,55 @@
+name: Book examples
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+
+jobs:
+  check-format:
+    name: Check coding conventions
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/cheriot-platform/devcontainer:latest
+      options: --user 1001
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Generate compiler_commands.json files
+      run: ./scripts/generate_compile_commands.sh
+    - name: Run clang-format
+      run: ./scripts/run_clang_format.sh /cheriot-tools/bin
+
+  build-test:
+    name: Build-test examples
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/cheriot-platform/devcontainer:latest
+      options: --user 1001
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Build examples
+      run: |
+        set -e
+        for example_dir in $PWD/examples/*/; do
+          if [ -f $example_dir/xmake.lua ] ; then
+            cd $example_dir
+            echo Building $example_dir
+            xmake f --sdk=/cheriot-tools/
+            xmake
+          fi
+        done
+
+  all-checks:
+    needs: [run-tests, check-format]
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dummy step
+      run: true

.gitignore

@@ -0,0 +1,2 @@
+.xmake
+build/

scripts/generate_compile_commands.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# Generate compile commands files for all known projects in this repo
+
+
+. "$(dirname $0)"/../cheriot-rtos/scripts/common.sh
+
+find_sdk $1
+
+echo "Using SDK=$SDK"
+
+# Generate compile_commands.json for all of the extra tests and examples.
+for dir in examples/* ; do
+	if [ -f "$dir/xmake.lua" ] ;  then
+		echo Generating compile_commands.json for $dir
+		(cd $dir && xmake f --sdk="${SDK}" && xmake project -k compile_commands)
+	fi
+done
+
+# Generate the top-level compile-commands.json
+cd cheriot-rtos/tests && xmake f --sdk="${SDK}" && xmake project -k compile_commands ..

scripts/run_clang_format.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -eo pipefail
+if [ ! -d examples ] ; then
+	echo Please run this script from the root of the CHERIoT book-examples repository.
+	exit 1
+fi
+CLANG_TIDY=/cheriot-tools/bin/clang-tidy
+CLANG_FORMAT=/cheriot-tools/bin/clang-format
+if [ -n "$1" ] ; then
+	CLANG_TIDY=$1/clang-tidy
+	CLANG_FORMAT=$1/clang-format
+fi
+if [ ! -x ${CLANG_TIDY} ] ; then
+	echo Usage: $0 path/to/cheriot/tools/bin
+	echo clang-tidy not found at ${CLANG_TIDY}
+	exit 1
+fi
+if [ ! -x ${CLANG_FORMAT} ] ; then
+	echo Usage: $0 path/to/cheriot/tools/bin
+	echo clang-format not found at ${CLANG_FORMAT}
+	exit 1
+fi
+
+if which nproc ; then
+	PARALLEL_JOBS=$(nproc)
+else
+	PARALLEL_JOBS=$(sysctl -n kern.smp.cpus)
+fi
+
+
+# Exclude the two files generated by BearSSL from formatting.
+FILES=$(find examples -name '*.h' -or -name '*.hh' -or -name '*.cc' -or -name '*.c' | grep -v 'DigiCertGlobalRootG2' | grep -v mosquitto.org.h)
+
+${CLANG_FORMAT} -i ${FILES}
+if ! git diff --exit-code ${HEADERS} ${SOURCES} ; then
+	echo clang-format applied changes
+	exit 1
+fi