Merge pull request #296 from LeeNX/leet-ci-updates

chore(ci): updates to add ```Sketches report size delta``` to PR workflows

Author: LeeNX

.github/workflows/main.yml

@@ -10,6 +10,9 @@ name: Compile Sketches
       - "ci-builds-*"
   pull_request:
   workflow_dispatch:
+  merge_group:
+  schedule:
+    - cron: "30 1 1 * *"    # Scheduled build test 01h30 1st of Month
 
 concurrency:
   # https://docs.github.com/en/actions/examples/using-concurrency-expressions-and-a-test-matrix
@@ -22,15 +25,24 @@ jobs:
   compile-sketches:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read        # needed to fetch base commit
+      pull-requests: write  # needed to post the delta report
+      checks: write         # (optional) if using Checks API instead of PR comment
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6
+        with:
+          fetch-depth: 0    # required for comparing base vs. head commits
 
       # See: https://github.com/arduino/compile-sketches#readme
       - name: Compile sketches
         uses: arduino/compile-sketches@v1
         with:
+          enable-deltas-report: true
           fqbn: esp32:esp32:esp32
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           sketch-paths: |
             - examples/CharacteristicsConfiguration/CharacteristicsConfiguration.ino
             - examples/DrivingControllerTest/DrivingControllerTest.ino
@@ -56,3 +68,12 @@ jobs:
             - name: Keypad
             - name: Bounce2
             - source-path: .
+
+      - name: Sketches report size delta
+        # Only run the action when the workflow is triggered by a pull request.
+        if: github.event_name == 'pull_request'
+        continue-on-error: true
+        uses: arduino/report-size-deltas@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-on-pr: true

.github/workflows/platformio.yml

@@ -24,7 +24,7 @@ jobs:
 
     strategy:
       matrix:
-        board: [esp32dev, lolin_c3_mini]
+        board: [esp32dev, lolin_c3_mini, esp32s3]
 
     steps:
       - name: Checkout code
@@ -44,4 +44,4 @@ jobs:
         run: |
           # pio run -d examples/TestAll/TestAll.ino -e ${{ matrix.board }} -D BLE_GAMEPAD_DEBUG=1 --verbose
           cd test/ci_build
-          pio run -e ${{ matrix.board }} --verbose
+          pio run -e ${{ matrix.board }}

README.md

@@ -1,9 +1,9 @@
 # ESP32-BLE-Gamepad
 
 ![Build](https://github.com/lemmingDev/ESP32-BLE-Gamepad/actions/workflows/main.yml/badge.svg)
-![PlatformIO](https://github.com/lemmingDev/ESP32-BLE-Gamepad/actions/workflows/main.yml/platform.svg)
+![PlatformIO](https://github.com/lemmingDev/ESP32-BLE-Gamepad/actions/workflows/platformio.yml/badge.svg)
 
-BLE Bluetooth HID GAMEPAD library for ESP32
+Bluetooth LE Gamepad library for the ESP32
 
 ## License
 Published under the MIT license. Please see license.txt.
@@ -27,9 +27,10 @@ It would be great however if any improvements are fed back into this version.
  - [x] Configurable BLE characteristics (name, manufacturer, model number, software revision, serial number, firmware revision, hardware revision)	
  - [x] Report optional battery level to host
  - [x] Uses efficient NimBLE bluetooth library
- - [x] Output report function
+ - [x] HID Output Report function
+ - [ ] HID Feature Report function
  - [x] Functions available for force pairing/ignore current client and/or delete pairings
- - [x] Nordic UART Service functionality at same time as gamepad. See examples
+ - [x] Nordic UART Service (NUS) functionality at same time as gamepad. See examples
  - [x] Compatible with Windows
  - [x] Compatible with Android (Android OS maps default buttons / axes / hats slightly differently than Windows) (see notes)
  - [x] Compatible with Linux (limited testing)

test/ci_build/platformio.ini

@@ -19,3 +19,14 @@ lib_deps =
   ../../
 build_flags =
   -D BLE_GAMEPAD_DEBUG=1
+
+[env:esp32s3]
+platform = espressif32
+board = esp32-s3-devkitc-1
+framework = arduino
+lib_ldf_mode = deep+
+lib_deps =
+  h2zero/NimBLE-Arduino
+  ../../
+build_flags =
+  -D BLE_GAMEPAD_DEBUG=1