Skip to content

feat: include spiffs.bin in release and switch console to USB-JTAG#152

Merged
crispyberry merged 1 commit intomemovai:mainfrom
IRONICBo:feat/release-spiffs
Mar 17, 2026
Merged

feat: include spiffs.bin in release and switch console to USB-JTAG#152
crispyberry merged 1 commit intomemovai:mainfrom
IRONICBo:feat/release-spiffs

Conversation

@IRONICBo
Copy link
Copy Markdown
Member

@IRONICBo IRONICBo commented Mar 16, 2026

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

    • SPIFFS now included in firmware releases as part of the merged firmware image and distributed with version-tagged binaries.
  • Chores

    • Updated console configuration to use USB Serial/JTAG instead of UART.

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.
@IRONICBo IRONICBo requested a review from crispyberry March 16, 2026 13:19
@IRONICBo IRONICBo self-assigned this Mar 16, 2026
@IRONICBo IRONICBo added enhancement New feature or request ready to merge labels Mar 16, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 16, 2026

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Release Workflow - SPIFFS Integration
.github/workflows/release.yml
Added SPIFFS binary (0x420000) to merged firmware image; updated flash offsets for existing partitions; includes spiffs-${VERSION}.bin in release artifacts and flash instructions.
SDK Configuration
sdkconfig.defaults.esp32s3
Replaced UART-based console configuration with USB Serial/JTAG as the primary console interface; removed CONFIG_ESP_CONSOLE_UART_DEFAULT and CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG; added CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hop, hop, hooray for SPIFFS so bright,
Now nestled at 0x420000, just right!
USB Serial leads the way,
Console hops faster today! 🔌

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the two main changes: adding spiffs.bin to releases and switching the console to USB-JTAG.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

Migrating from UI to YAML configuration.

Use the @coderabbitai configuration command in a PR comment to get a dump of all your UI settings in YAML format. You can then edit this YAML file and upload it to the root of your repository to configure CodeRabbit programmatically.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🟡 Minor

Update 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

📥 Commits

Reviewing files that changed from the base of the PR and between 9f17f1d and 2b68d56.

📒 Files selected for processing (2)
  • .github/workflows/release.yml
  • sdkconfig.defaults.esp32s3

@IRONICBo
Copy link
Copy Markdown
Member Author

@crispyberry Hi, I need this CI to release binary files with spiff, could you approve it?

@crispyberry crispyberry merged commit bb10ea0 into memovai:main Mar 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants