mirror of
https://github.com/ratspeak/ratdeck.git
synced 2026-03-30 22:25:39 +00:00
2a7808cf5a
Standardized checklist for version bumps, tagging, post-release verification, and hotfix workflow. Moves inline release steps from BUILDING.md into dedicated RELEASING.md.
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
# Ratdeck — Release Protocol
|
|
|
|
## Pre-Release Checklist
|
|
|
|
1. All changes committed and pushed to `main`
|
|
2. Local build succeeds: `pio run -e ratdeck_915`
|
|
3. Flash and test on device — confirm boot completes and basic functionality works
|
|
4. Version bumped in `src/config/Config.h` (all 4 defines: `RATDECK_VERSION_MAJOR`, `RATDECK_VERSION_MINOR`, `RATDECK_VERSION_PATCH`, `RATDECK_VERSION_STRING`)
|
|
|
|
## Release Steps
|
|
|
|
```bash
|
|
# 1. Commit version bump
|
|
git add src/config/Config.h
|
|
git commit -m "vX.Y.Z: description of changes"
|
|
|
|
# 2. Push to main
|
|
git push origin main
|
|
|
|
# 3. Create and push tag
|
|
git tag vX.Y.Z
|
|
git push origin vX.Y.Z
|
|
|
|
# CI automatically builds and creates GitHub release with ratdeck-firmware.zip
|
|
```
|
|
|
|
## Post-Release Verification
|
|
|
|
1. Check [GitHub Actions](https://github.com/ratspeak/ratdeck/actions) — both build and release jobs should pass
|
|
2. Verify the [release page](https://github.com/ratspeak/ratdeck/releases) has `ratdeck-firmware.zip` attached
|
|
3. Download the ZIP and confirm it contains:
|
|
- `bootloader.bin`
|
|
- `partitions.bin`
|
|
- `boot_app0.bin`
|
|
- `firmware.bin`
|
|
- `manifest.json`
|
|
4. Web flasher at [ratspeak.org/download](https://ratspeak.org/download.html) should pick up the new release
|
|
|
|
## Hotfix Protocol
|
|
|
|
For critical bugs in a released version:
|
|
|
|
1. Fix on `main` branch
|
|
2. Bump patch version (e.g., 1.5.9 → 1.5.10)
|
|
3. Follow normal release steps above
|
|
|
|
## Build Environment Reference
|
|
|
|
| Parameter | Value |
|
|
|-----------|-------|
|
|
| PlatformIO env | `ratdeck_915` |
|
|
| Version defines | `RATDECK_VERSION_MAJOR/MINOR/PATCH/STRING` |
|
|
| Firmware artifact | `ratdeck-firmware.zip` |
|
|
| Flash size | 16MB |
|
|
| Flash mode | qio |
|
|
| PSRAM | 8MB (enabled via `BOARD_HAS_PSRAM`) |
|