Add script (and CI check) to check / update the autogenerated pioasm outputs

Author: lurch

.github/workflows/pioasm_outputs.yml

@@ -0,0 +1,30 @@
+name: Check pioasm output files
+on: [push, pull_request]
+
+jobs:
+  check-pioasm-outputs:
+    # Prevent running twice for PRs from same repo
+    if: github.repository_owner == 'raspberrypi' && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name)
+    runs-on: [self-hosted, Linux, X64]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Checkout pico-sdk/develop
+      uses: actions/checkout@v4
+      with:
+        repository: raspberrypi/pico-sdk
+        ref: develop
+        path: pico-sdk
+
+    - name: Rebuild pioasm outputs
+      run: PICO_SDK_PATH=${{github.workspace}}/pico-sdk ./update_pioasm_outputs.sh
+
+    - name: Check pioasm outputs for changes
+      run: |
+        if git status --porcelain | grep -q '^ M'; then
+          echo "::error title=outdated-files::Autogenerated pioasm output files are out of date - update by running update_pioasm_outputs.sh"
+          exit 1
+        fi
+

update_pioasm_outputs.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+set -x
+# Helper-script to update the pioasm-generated files in pico-examples repo
+PIOASM_COMMENT_STRING="This file is autogenerated by pioasm"
+if [ -z $PICO_SDK_PATH ]; then
+  echo "PICO_SDK_PATH envvar not set"
+  exit 1
+fi
+if [ ! -d $PICO_SDK_PATH ]; then
+  echo "PICO_SDK_PATH envvar ($PICO_SDK_PATH) is invalid"
+  exit 1
+fi
+# convert to absolute path
+PICO_SDK_PATH=$(realpath $PICO_SDK_PATH)
+BUILD_DIR=$(mktemp -d -p .)
+cleanup() {
+  if [[ -d "$BUILD_DIR" ]]; then
+    rm -rf "$BUILD_DIR"
+  fi
+}
+trap cleanup EXIT
+SCRIPTNAME=$(basename "$0")
+PIOASM_OUTPUT_DIRS=()
+while read -r DIRNAME; do
+  if [ "$DIRNAME" != "$SCRIPTNAME" ]; then
+    PIOASM_OUTPUT_DIRS+=("$DIRNAME")
+  fi
+done <<< "$(git grep -l "$PIOASM_COMMENT_STRING" | cut -d/ -f1-2 | sort | uniq)"
+while read -r FILENAME; do
+  if [ "$FILENAME" != "$SCRIPTNAME" ]; then
+    rm "$FILENAME"
+  fi
+done <<< "$(git grep -l "$PIOASM_COMMENT_STRING")"
+cmake -S . -B "$BUILD_DIR" -DPICO_SDK_PATH=$PICO_SDK_PATH -DPICO_NO_PICOTOOL=1
+for DIRNAME in "${PIOASM_OUTPUT_DIRS[@]}"; do
+  make -j4 -C "$BUILD_DIR/$DIRNAME"
+done
+cleanup