From 1fce76600cec66b21888371a63259929eb81743e Mon Sep 17 00:00:00 2001 From: Frank <91616163+softhack007@users.noreply.github.com> Date: Sun, 5 Apr 2026 15:21:30 +0200 Subject: [PATCH] strengthen that at one firmware build is necessary after code changes. --- .github/agent-build-instructions.md | 4 ++-- .github/copilot-instructions.md | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/agent-build-instructions.md b/.github/agent-build-instructions.md index fe730314..2e6ef0a9 100644 --- a/.github/agent-build-instructions.md +++ b/.github/agent-build-instructions.md @@ -38,12 +38,12 @@ Use these timeout values when running builds: 3. Then build and test firmware -## Before Finishing Work +## Before Finishing Work - Testing **You MUST complete ALL of these before marking work as done:** 1. **Run tests**: `npm test` — must pass -2. **Build firmware**: `pio run -e esp32_4MB_V4_M` — must succeed +2. **Build firmware**: `pio run -e esp32_4MB_V4_M` — must succeed after source code changes, **never skip this step**. - Set timeout to 30+ minutes, **never cancel** - Choose `esp32_4MB_V4_M` as a common, representative environment - If the build fails, fix the issue before proceeding diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index fdebb568..5032c5d6 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -28,8 +28,8 @@ Always reference these instructions first and fallback to search or bash command | ESP32-P4/-C5/-C6 | Will be supported in the future | | ESP8266 | Deprecated — should still compile, but not actively maintained | - ## Build and Test + | Command | Purpose | Typical Time | |---|---|---| @@ -38,13 +38,14 @@ Always reference these instructions first and fallback to search or bash command | `npm run dev` | Watch mode — auto-rebuilds web UI on file changes | — | | `pio run -e ` | Build firmware for a hardware target | 15–20 min | -**Always run `npm ci; npm run build` before `pio run`.** The web UI build generates `wled00/html_*.h` header files required by firmware compilation. + +**Always run `npm ci; npm run build` before `pio run`.** The web UI build generates `wled00/html_*.h` header files required by firmware compilation. +**Build firmware to validate code changes**: `pio run -e esp32_4MB_V4_M` — must succeed, never skip this step. Common firmware environments: `esp32_4MB_V4_M`, `esp32_16MB_V4_S_HUB75`, `esp32S3_8MB_PSRAM_M_qspi`, `esp32_16MB_V4_M_eth`, `esp32dev_compat`, `esp8266_4MB_S` (deprecated) For detailed build timeouts, development workflows, troubleshooting, and validation steps, see [agent-build-instructions.md](agent-build-instructions.md). - ## Repository Structure tl;dr: