Skip to content

RELEASE.md

Latest commit

 

History

History
114 lines (81 loc) · 3.03 KB

RELEASE.md

File metadata and controls

114 lines (81 loc) · 3.03 KB
Raw

Release generation

Rustmix Wave has three release helpers:

scripts/build-release-firmware.sh  Build an ELF-only firmware release bundle
scripts/flash-release.sh           Flash an existing release ELF safely
scripts/package-release.sh         Package the cleaned GitHub-ready source tree

Supported release artifact

The supported firmware artifact is the ESP-IDF release ELF:

dist/waveshare-epd397-rust-app-v<VERSION>.elf

Flash it with the ELF-aware espflash flash command:

./scripts/flash-release.sh \
  dist/waveshare-epd397-rust-app-v<VERSION>.elf

Equivalent direct command:

espflash flash --chip esp32s3 --monitor \
  dist/waveshare-epd397-rust-app-v<VERSION>.elf

Ordinary development flashing remains unchanged:

./scripts/flash.sh monitor

Safety warning: do not use raw-address flashing

Do not use espflash write-bin for the release ELF or for any artifact from this repository. write-bin is a raw-address operation. A raw write requires an explicitly validated flash layout and correct bootloader, partition-table, and application offsets.

The earlier unverified *-flash.bin artifact and the write-bin ... 0x0 workflow have been removed.

Future merged factory image

A merged factory-image workflow remains deferred. It may be added only after all of the following have been validated on physical hardware:

  • Bootloader offset and image
  • Partition-table offset and image
  • Factory application partition offset
  • Flash mode, frequency, and size
  • Recovery procedure from ROM download mode

Until then, the ELF-aware espflash flash path is the only supported release installation method.

Build a firmware release

./scripts/build-release-firmware.sh

The script:

  1. Runs ./scripts/validate.sh unless --skip-validate is provided.
  2. Builds the embedded release ELF with cargo +esp build --release.
  3. Copies the ELF into dist/.
  4. Copies the safe flash-release.sh helper into dist/.
  5. Writes SHA-256 checksums.
  6. Generates a release ZIP containing the ELF, flashing helper, checksum manifest, and flashing instructions.

Output naming:

dist/waveshare-epd397-rust-app-v<VERSION>.elf
dist/waveshare-epd397-rust-app-v<VERSION>-flash-release.sh
dist/waveshare-epd397-rust-app-v<VERSION>-firmware-release.sha256
dist/waveshare-epd397-rust-app-v<VERSION>-FLASHING.txt
dist/waveshare-epd397-rust-app-v<VERSION>-firmware-release.zip

No *-flash.bin artifact is generated.

Skip validation during a repeated local build

./scripts/build-release-firmware.sh --skip-validate

Use this only after the exact source tree has already passed ./scripts/validate.sh.

Package cleaned source

./scripts/package-release.sh

This produces:

dist/waveshare-epd397-rust-app-v<VERSION>-github-ready.zip
dist/waveshare-epd397-rust-app-v<VERSION>-github-ready.zip.sha256

The source package excludes Git metadata, build outputs, generated release artifacts, local caches, patch scratch files, and extracted overlay directories.