mirror of
https://github.com/ruvnet/RuView.git
synced 2026-10-18 21:00:22 -05:00
259 lines
10 KiB
YAML
259 lines
10 KiB
YAML
name: Firmware CI
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- '**'
|
|
tags:
|
|
# ESP32 firmware release tags — build + version-consistency guard (RuView#505).
|
|
- 'v*-esp32'
|
|
paths:
|
|
- 'firmware/**'
|
|
- '.github/workflows/firmware-ci.yml'
|
|
pull_request:
|
|
paths:
|
|
- 'firmware/**'
|
|
- '.github/workflows/firmware-ci.yml'
|
|
|
|
jobs:
|
|
provisioning-tests:
|
|
name: Provisioning tooling tests
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262
|
|
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
|
|
with:
|
|
python-version: '3.11'
|
|
- name: Verify provisioning and secret handling without hardware
|
|
run: python -m unittest discover -s firmware/esp32-csi-node/tests -p 'test_provision*.py' -v
|
|
|
|
version-guard:
|
|
name: Verify version.txt matches release tag
|
|
runs-on: ubuntu-latest
|
|
if: github.ref_type == 'tag'
|
|
steps:
|
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262
|
|
with:
|
|
submodules: recursive
|
|
- name: Check firmware version.txt == tag
|
|
run: |
|
|
# Tag form: vX.Y.Z-esp32 → expect version.txt to contain X.Y.Z
|
|
TAG="${GITHUB_REF_NAME}"
|
|
EXPECTED="${TAG#v}"
|
|
EXPECTED="${EXPECTED%-esp32}"
|
|
ACTUAL="$(tr -d '[:space:]' < firmware/esp32-csi-node/version.txt)"
|
|
echo "Tag: $TAG → expected version.txt: $EXPECTED | actual: $ACTUAL"
|
|
if [ "$EXPECTED" != "$ACTUAL" ]; then
|
|
echo "::error::firmware/esp32-csi-node/version.txt is '$ACTUAL' but tag '$TAG' expects '$EXPECTED'."
|
|
echo "::error::Bump version.txt and re-tag so esp_app_get_description()->version is correct (RuView#505)."
|
|
exit 1
|
|
fi
|
|
echo "version.txt matches the release tag."
|
|
|
|
build:
|
|
name: Build firmware (${{ matrix.target }} / ${{ matrix.variant }})
|
|
runs-on: ubuntu-latest
|
|
container:
|
|
image: espressif/idf:v5.4
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- variant: 8mb
|
|
target: esp32s3
|
|
sdkconfig: sdkconfig.defaults
|
|
partition_table_name: partitions_display.csv
|
|
size_warn_kb: 1100
|
|
# Current 8 MB image is 1163 KiB after USB onboarding. The OTA app
|
|
# partition is 2048 KiB; retain a 1200 KiB hard gate and warning.
|
|
size_limit_kb: 1200
|
|
artifact_app: esp32-csi-node.bin
|
|
artifact_pt: partition-table.bin
|
|
- variant: 4mb
|
|
target: esp32s3
|
|
sdkconfig: sdkconfig.defaults.4mb
|
|
partition_table_name: partitions_4mb.csv
|
|
size_warn_kb: 1100
|
|
size_limit_kb: 1152
|
|
artifact_app: esp32-csi-node-4mb.bin
|
|
artifact_pt: partition-table-4mb.bin
|
|
# ADR-110: ESP32-C6 research target (Wi-Fi 6 / 802.15.4 / TWT / LP-core)
|
|
- variant: c6-4mb
|
|
target: esp32c6
|
|
sdkconfig: sdkconfig.defaults
|
|
partition_table_name: partitions_4mb.csv
|
|
size_warn_kb: 1100
|
|
size_limit_kb: 1152
|
|
artifact_app: esp32-csi-node-c6.bin
|
|
artifact_pt: partition-table-c6.bin
|
|
|
|
steps:
|
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262
|
|
with:
|
|
submodules: recursive
|
|
|
|
- name: Build firmware (${{ matrix.variant }})
|
|
working-directory: firmware/esp32-csi-node
|
|
run: |
|
|
. $IDF_PATH/export.sh
|
|
# 4mb variant supplies its own sdkconfig.defaults overlay.
|
|
# c6-4mb variant relies on the auto-applied sdkconfig.defaults.esp32c6
|
|
# overlay (ESP-IDF auto-loads sdkconfig.defaults.$TARGET when present).
|
|
if [ "${{ matrix.variant }}" = "4mb" ]; then
|
|
cp "${{ matrix.sdkconfig }}" sdkconfig.defaults
|
|
fi
|
|
idf.py set-target ${{ matrix.target }}
|
|
idf.py build
|
|
|
|
- name: Build and run host-side firmware unit tests
|
|
if: matrix.variant == 'c6-4mb'
|
|
working-directory: firmware/esp32-csi-node/test
|
|
run: |
|
|
make host_tests
|
|
|
|
- name: Verify binary size budget
|
|
working-directory: firmware/esp32-csi-node
|
|
run: |
|
|
BIN=build/esp32-csi-node.bin
|
|
SIZE=$(stat -c%s "$BIN")
|
|
MAX=$((${{ matrix.size_limit_kb }} * 1024))
|
|
WARN=$((${{ matrix.size_warn_kb }} * 1024))
|
|
echo "Binary size: $SIZE bytes ($(( SIZE / 1024 )) KB)"
|
|
echo "Warning at: $WARN bytes (${{ matrix.size_warn_kb }} KB)"
|
|
echo "Size limit: $MAX bytes (${{ matrix.size_limit_kb }} KB)"
|
|
if [ "$SIZE" -gt "$MAX" ]; then
|
|
echo "::error::Firmware binary exceeds ${{ matrix.size_limit_kb }} KB size gate ($SIZE > $MAX)"
|
|
exit 1
|
|
fi
|
|
if [ "$SIZE" -gt "$WARN" ]; then
|
|
echo "::warning::Firmware binary exceeds the ${{ matrix.size_warn_kb }} KB soft budget ($SIZE > $WARN); hard limit is ${{ matrix.size_limit_kb }} KB"
|
|
fi
|
|
echo "Binary size OK: $SIZE <= $MAX"
|
|
|
|
- name: Verify built application version before packaging
|
|
working-directory: firmware/esp32-csi-node
|
|
run: python test/test_delivery_contract.py --built-app build/esp32-csi-node.bin
|
|
|
|
- name: Verify flash image integrity
|
|
working-directory: firmware/esp32-csi-node
|
|
run: |
|
|
ERRORS=0
|
|
BIN=build/esp32-csi-node.bin
|
|
|
|
if [ ! -s "$BIN" ]; then
|
|
echo "::error::Binary not found or empty"
|
|
exit 1
|
|
fi
|
|
|
|
PT=build/partition_table/partition-table.bin
|
|
if [ -f "$PT" ]; then
|
|
MAGIC=$(od -A n -t x1 -N 2 "$PT" | tr -d ' ')
|
|
if [ "$MAGIC" != "aa50" ]; then
|
|
echo "::warning::Partition table magic mismatch: $MAGIC (expected aa50)"
|
|
ERRORS=$((ERRORS + 1))
|
|
fi
|
|
fi
|
|
|
|
BL=build/bootloader/bootloader.bin
|
|
if [ ! -s "$BL" ]; then
|
|
echo "::warning::Bootloader binary missing or empty"
|
|
ERRORS=$((ERRORS + 1))
|
|
fi
|
|
|
|
NONZERO=$(od -A n -t x1 -N 1024 "$BIN" | tr -d ' f\n' | wc -c)
|
|
if [ "$NONZERO" -lt 100 ]; then
|
|
echo "::error::Binary appears to be mostly padding (non-zero chars: $NONZERO)"
|
|
ERRORS=$((ERRORS + 1))
|
|
fi
|
|
|
|
if [ "$ERRORS" -gt 0 ]; then
|
|
echo "::warning::Flash image verification completed with $ERRORS warning(s)"
|
|
else
|
|
echo "Flash image integrity verified"
|
|
fi
|
|
|
|
- name: Stage release binaries with variant-specific names
|
|
working-directory: firmware/esp32-csi-node
|
|
run: |
|
|
mkdir -p release-staging
|
|
cp build/esp32-csi-node.bin release-staging/${{ matrix.artifact_app }}
|
|
cp build/partition_table/partition-table.bin release-staging/${{ matrix.artifact_pt }}
|
|
cp build/bootloader/bootloader.bin release-staging/bootloader.bin
|
|
cp build/ota_data_initial.bin release-staging/ota_data_initial.bin
|
|
cp version.txt release-staging/version.txt
|
|
(cd release-staging && sha256sum \
|
|
"${{ matrix.artifact_app }}" \
|
|
"${{ matrix.artifact_pt }}" \
|
|
bootloader.bin ota_data_initial.bin version.txt \
|
|
> SHA256SUMS.txt)
|
|
ls -la release-staging/
|
|
|
|
- name: Check QEMU ESP32-S3 support status
|
|
run: |
|
|
echo "::notice::ESP32-S3 QEMU support is experimental in ESP-IDF v5.4. "
|
|
echo "Full smoke testing requires QEMU 8.2+ with xtensa-esp32s3 target."
|
|
echo "See: https://github.com/espressif/qemu/wiki"
|
|
|
|
- name: Upload firmware artifact (${{ matrix.variant }})
|
|
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
|
|
with:
|
|
name: esp32-csi-node-firmware-${{ matrix.variant }}
|
|
path: firmware/esp32-csi-node/release-staging/
|
|
retention-days: 90
|
|
|
|
build-c6-idf6:
|
|
name: Build XIAO C6 external antenna (ESP-IDF 6.0.2)
|
|
runs-on: ubuntu-latest
|
|
container:
|
|
image: espressif/idf:v6.0.2
|
|
steps:
|
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262
|
|
with:
|
|
submodules: recursive
|
|
|
|
- name: Build the IDF 6 canary image
|
|
working-directory: firmware/esp32-csi-node
|
|
run: |
|
|
. $IDF_PATH/export.sh
|
|
idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.esp32c6;sdkconfig.defaults.xiao-external" set-target esp32c6
|
|
idf.py build
|
|
test "$(stat -c%s build/esp32-csi-node.bin)" -le $((1152 * 1024))
|
|
strings build/esp32-csi-node.bin | grep -F "external U.FL"
|
|
|
|
publish-release-assets:
|
|
name: Publish firmware release assets
|
|
if: github.ref_type == 'tag'
|
|
needs: [version-guard, provisioning-tests, build, build-c6-idf6]
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
steps:
|
|
- name: Download the exact-run firmware artifacts
|
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
|
|
with:
|
|
pattern: esp32-csi-node-firmware-*
|
|
path: release-downloads
|
|
|
|
- name: Package variants without filename collisions
|
|
run: |
|
|
mkdir -p release-assets
|
|
for directory in release-downloads/esp32-csi-node-firmware-*; do
|
|
variant="${directory##*/}"
|
|
tar -C "$directory" -czf "release-assets/${variant}.tar.gz" .
|
|
done
|
|
(cd release-assets && sha256sum *.tar.gz > SHA256SUMS.txt)
|
|
|
|
- name: Publish the downloadable firmware bundles
|
|
uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65
|
|
with:
|
|
name: ESP32 firmware ${{ github.ref_name }}
|
|
prerelease: true
|
|
make_latest: false
|
|
body: |
|
|
Exact-run ESP32-S3 display 8 MB, ESP32-S3 headless 4 MB, and ESP32-C6 4 MB firmware bundles.
|
|
Verify each archive against `SHA256SUMS.txt` before flashing.
|
|
CI builds and host tests verify software behavior, not target hardware.
|
|
This prerelease has no new physical-board qualification or sensing-accuracy claim.
|
|
Select the matching board configuration using firmware/esp32-csi-node/README.md.
|
|
files: release-assets/*
|