feat: include spiffs.bin in release and switch console to USB-JTAG#152
feat: include spiffs.bin in release and switch console to USB-JTAG#152crispyberry merged 1 commit intomemovai:mainfrom
Conversation
Add spiffs.bin to CI release artifacts and merged firmware image. Switch primary console from UART to USB-Serial-JTAG so web serial monitor can interact with the device directly over USB.
📝 WalkthroughWalkthroughThe pull request updates the GitHub Actions release workflow to integrate SPIFFS into the firmware build artifacts and modifies the ESP32-S3 SDK configuration to use USB Serial/JTAG as the default console interface instead of UART. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip Migrating from UI to YAML configuration.Use the |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/release.yml (1)
82-82:⚠️ Potential issue | 🟡 MinorUpdate first-time setup instructions to reflect USB Serial/JTAG console.
The console has been switched to USB Serial/JTAG (
CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG), but the instructions still reference "serial (115200 baud)" which implies traditional UART. USB Serial/JTAG uses native USB CDC protocol where baud rate settings are typically ignored.Consider updating to clarify USB connection:
📝 Suggested documentation update
- After flashing, connect via serial (115200 baud) and configure: + After flashing, connect via USB Serial (the device appears as a CDC device) and configure:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/release.yml at line 82, Update the first-time setup line to reference the USB Serial/JTAG console instead of a traditional UART—mention CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG and instruct users to connect the device via USB and open the host-side CDC/USB serial console (baud setting is typically ignored for USB CDC), removing or clarifying the "115200 baud" wording to avoid implying a UART connection.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In @.github/workflows/release.yml:
- Line 82: Update the first-time setup line to reference the USB Serial/JTAG
console instead of a traditional UART—mention CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
and instruct users to connect the device via USB and open the host-side CDC/USB
serial console (baud setting is typically ignored for USB CDC), removing or
clarifying the "115200 baud" wording to avoid implying a UART connection.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 462b4219-1df5-4fbc-90c5-bf38898a8e00
📒 Files selected for processing (2)
.github/workflows/release.ymlsdkconfig.defaults.esp32s3
|
@crispyberry Hi, I need this CI to release binary files with spiff, could you approve it? |
Add spiffs.bin to CI release artifacts and merged firmware image. Switch primary console from UART to USB-Serial-JTAG so web serial monitor can interact with the device directly over USB.
Summary by CodeRabbit
New Features
Chores