Add Board Header Check Action (#2519)

* Add action to check board headers when modified

* Fix invalid escape warning

* Check for more board header errors before exiting script

* Also run when action file changes

* Add back newline at end of check_all_board_headers.sh

* Remove python install step

* `e.__str__()` -> `str(e)`

Author: will-v-pi

.github/workflows/check_board.yml

@@ -0,0 +1,27 @@
+name: Check Board Headers
+
+on:
+  push:
+    paths:
+      - 'src/boards/include/boards/**'
+      - 'tools/check_board_header.py'
+      - 'tools/check_all_board_headers.sh'
+      - '.github/workflows/check_board.yml'
+  pull_request:
+    paths:
+      - 'src/boards/include/boards/**'
+      - 'tools/check_board_header.py'
+      - 'tools/check_all_board_headers.sh'
+      - '.github/workflows/check_board.yml'
+
+jobs:
+  check-board-headers:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check Board Headers
+        run: |
+          tools/check_all_board_headers.sh

tools/check_all_board_headers.sh

@@ -1,7 +1,12 @@
 #!/bin/bash
+
+EXIT_CODE=0
+
 for HEADER in src/boards/include/boards/*.h; do
     tools/check_board_header.py $HEADER
     if [[ $? -ne 0 ]]; then
-      break
+      EXIT_CODE=1
     fi
 done
+
+exit $EXIT_CODE

tools/check_board_header.py

@@ -28,7 +28,7 @@
     # Python <3.11 doesn't have ExceptionGroup, so define a simple one
     class ExceptionGroup(Exception):
         def __init__(self, message, errors):
-            message += "\n" + "\n".join(e.__str__() for e in errors)
+            message += "\n" + "\n".join(str(e) for e in errors)
             super().__init__(message)
 
 logger = logging.getLogger(__name__)

tools/extract_build_defines.py

@@ -28,7 +28,7 @@
     # Python <3.11 doesn't have ExceptionGroup, so define a simple one
     class ExceptionGroup(Exception):
         def __init__(self, message, errors):
-            message += "\n" + "\n".join(e.__str__() for e in errors)
+            message += "\n" + "\n".join(str(e) for e in errors)
             super().__init__(message)
 
 logger = logging.getLogger(__name__)

tools/extract_cmake_configs.py

@@ -26,7 +26,7 @@
     # Python <3.11 doesn't have ExceptionGroup, so define a simple one
     class ExceptionGroup(Exception):
         def __init__(self, message, errors):
-            message += "\n" + "\n".join(e.__str__() for e in errors)
+            message += "\n" + "\n".join(str(e) for e in errors)
             super().__init__(message)
 
 logger = logging.getLogger(__name__)

tools/extract_cmake_functions.py

@@ -28,7 +28,7 @@
     # Python <3.11 doesn't have ExceptionGroup, so define a simple one
     class ExceptionGroup(Exception):
         def __init__(self, message, errors):
-            message += "\n" + "\n".join(e.__str__() for e in errors)
+            message += "\n" + "\n".join(str(e) for e in errors)
             super().__init__(message)
 
 logger = logging.getLogger(__name__)