mirror of
https://github.com/MarekZegare4/MeshCore-Solo.git
synced 2026-10-09 03:06:39 +00:00
chore: stage I1 -- repo cleanup, minimal README
Working plans (docs/development, docs/design redesign notes) removed; the two developer guides moved to docs/developer/. README cut to devices, flashing, links and building (Wio Tracker L2 added); its feature list and doc tables moved to docs/solo_features/README.md. RELEASE.md describes the Solo release flow. Upstream's GitHub Pages workflow (docs.meshcore.io) dropped, CLAUDE.md untracked, Buy Me a Coffee back in FUNDING.yml. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
+15
-13
@@ -1,15 +1,17 @@
|
||||
# Releasing Firmware
|
||||
# Releasing Solo firmware
|
||||
|
||||
GitHub Actions is set up to automatically build and release firmware.
|
||||
1. Add the notes for the new version at the top of `release-notes.md`.
|
||||
2. Push a `v*` tag (e.g. `v1.29`). [Build Solo Firmwares](./.github/workflows/build-solo-firmwares.yml)
|
||||
builds every `*_solo_dual` and `*_solo_lvgl` environment in `solo/` with
|
||||
`FIRMWARE_VERSION` set to the tag and opens a **draft** release with:
|
||||
- `.uf2` + `-ota.zip` (DFU package) for nRF52 boards;
|
||||
- `-merged.bin` (flash at `0x0`) for ESP32 boards;
|
||||
- `-ota.bin` (app image) for the `*_solo_lvgl` boards — what their
|
||||
Settings › System › Firmware update downloads.
|
||||
3. Paste the notes into the draft and publish it. Only a published,
|
||||
non-prerelease release is what devices and the website see as the latest:
|
||||
the on-device update reads `releases/latest`, and the website's simulator
|
||||
is refreshed from its `solo-sim-wasm.zip` ([Build Solo Sim](./.github/workflows/build-solo-sim.yml)).
|
||||
|
||||
It will automatically build firmware when one of the following tag formats are pushed.
|
||||
|
||||
- `companion-v1.0.0`
|
||||
- `repeater-v1.0.0`
|
||||
- `room-server-v1.0.0`
|
||||
|
||||
> NOTE: replace `v1.0.0` with the version you want to release as.
|
||||
|
||||
- You can push one, or more tags on the same commit, and they will all build separately.
|
||||
- Once the firmware has been built, a new (draft) GitHub Release will be created.
|
||||
- You will need to update the release notes, and publish it.
|
||||
The upstream `companion-v*`, `repeater-v*` and `room-server-v*` tags still
|
||||
build the stock firmwares through their own workflows.
|
||||
|
||||
Reference in New Issue
Block a user