|
| 1 | +# Release Process |
| 2 | + |
| 3 | +This checklist is the release runbook for Open Wemo. |
| 4 | + |
| 5 | +The current repo workflow is: |
| 6 | + |
| 7 | +- day-to-day work lands on `develop` |
| 8 | +- release candidates are merged to `main` |
| 9 | +- CI runs on `main` / `master` |
| 10 | +- a pushed tag matching `v*.*.*` triggers the GitHub release workflow |
| 11 | +- GitHub release notes are generated from commit subjects between the previous tag and the new tag |
| 12 | + |
| 13 | +## Release Checklist |
| 14 | + |
| 15 | +### 1. Stabilize the release branch |
| 16 | + |
| 17 | +- [ ] Start from `develop` |
| 18 | +- [ ] Pull the latest branch state |
| 19 | +- [ ] Confirm the working tree is clean |
| 20 | +- [ ] Review the commits that will go into the release |
| 21 | +- [ ] Clean up noisy commit history before release if needed (squash fixups, avoid vague subjects, make commit titles user-facing) |
| 22 | + |
| 23 | +```bash |
| 24 | +git checkout develop |
| 25 | +git pull origin develop |
| 26 | +git status |
| 27 | +git log --oneline origin/main..HEAD |
| 28 | +``` |
| 29 | + |
| 30 | +Notes: |
| 31 | + |
| 32 | +- The release workflow uses commit subjects to build the GitHub release notes, so commit titles matter. |
| 33 | +- Good subjects: `Fix LED Mode reviving devices that are intentionally off` |
| 34 | +- Bad subjects: `wip`, `fix stuff`, `debug`, `try again` |
| 35 | + |
| 36 | +### 2. Update release-facing docs |
| 37 | + |
| 38 | +- [ ] Update `README.md` for any user-visible changes |
| 39 | +- [ ] Update API docs if endpoints or payloads changed (`docs/API.md`) |
| 40 | +- [ ] Update protocol or architecture docs if behavior changed significantly |
| 41 | +- [ ] Make sure contributor workflow is still accurate if the process changed (`CONTRIBUTING.md`) |
| 42 | + |
| 43 | +For the current release, specifically verify the docs cover: |
| 44 | + |
| 45 | +- LED Mode behavior |
| 46 | +- standby threshold behavior |
| 47 | +- any changed expectations for Insight devices |
| 48 | + |
| 49 | +### 3. Bump versions consistently |
| 50 | + |
| 51 | +- [ ] Choose the correct semver bump |
| 52 | +- [ ] Update version in root package |
| 53 | +- [ ] Update version in bridge package |
| 54 | +- [ ] Update version in web package |
| 55 | +- [ ] Re-check for any hard-coded version references that should match the release |
| 56 | + |
| 57 | +Files to update: |
| 58 | + |
| 59 | +- `package.json` |
| 60 | +- `packages/bridge/package.json` |
| 61 | +- `packages/web/package.json` |
| 62 | + |
| 63 | +Versioning guide: |
| 64 | + |
| 65 | +- patch: bug fixes, no breaking changes |
| 66 | +- minor: new features, backward-compatible |
| 67 | +- major: breaking changes |
| 68 | + |
| 69 | +### 4. Run the full validation pass |
| 70 | + |
| 71 | +- [ ] Install dependencies if needed |
| 72 | +- [ ] Run typecheck |
| 73 | +- [ ] Run lint |
| 74 | +- [ ] Run tests |
| 75 | +- [ ] Run at least a Linux release build locally |
| 76 | +- [ ] Prefer running all platform builds before tagging if practical |
| 77 | + |
| 78 | +```bash |
| 79 | +bun install |
| 80 | +bun run typecheck |
| 81 | +bun run lint |
| 82 | +bun test |
| 83 | +bun run build:linux |
| 84 | +# optional but recommended before release |
| 85 | +bun run build:all |
| 86 | +``` |
| 87 | + |
| 88 | +### 5. Do release-candidate smoke testing |
| 89 | + |
| 90 | +- [ ] Launch the local build you intend to ship |
| 91 | +- [ ] Verify the app starts cleanly |
| 92 | +- [ ] Verify the most important changed behaviors manually |
| 93 | +- [ ] Verify no obvious regressions in core flows |
| 94 | + |
| 95 | +Suggested smoke-test areas: |
| 96 | + |
| 97 | +- device discovery |
| 98 | +- device on/off control |
| 99 | +- Insight status reporting |
| 100 | +- LED Mode toggle behavior |
| 101 | +- standby threshold behavior |
| 102 | +- timer flow if related code changed |
| 103 | + |
| 104 | +### 6. Prepare the final release commit set |
| 105 | + |
| 106 | +- [ ] Commit doc updates, version bumps, and release-prep changes |
| 107 | +- [ ] Make sure the final commit set is understandable when read as release notes |
| 108 | +- [ ] Push the final `develop` branch state |
| 109 | + |
| 110 | +```bash |
| 111 | +git add . |
| 112 | +git commit -m "Prepare vX.Y.Z release" |
| 113 | +git push origin develop |
| 114 | +``` |
| 115 | + |
| 116 | +### 7. Merge to the release branch |
| 117 | + |
| 118 | +- [ ] Merge `develop` into `main` |
| 119 | +- [ ] Push `main` |
| 120 | +- [ ] Wait for CI on `main` to pass before tagging |
| 121 | + |
| 122 | +```bash |
| 123 | +git checkout main |
| 124 | +git pull origin main |
| 125 | +git merge develop --no-ff -m "Merge develop for vX.Y.Z" |
| 126 | +git push origin main |
| 127 | +``` |
| 128 | + |
| 129 | +Current CI behavior from `.github/workflows/ci.yml`: |
| 130 | + |
| 131 | +- lint/typecheck job |
| 132 | +- test job |
| 133 | +- Linux build verification job |
| 134 | + |
| 135 | +### 8. Create and push the release tag |
| 136 | + |
| 137 | +- [ ] Create an annotated semver tag |
| 138 | +- [ ] Push the tag |
| 139 | +- [ ] Confirm the release workflow starts |
| 140 | + |
| 141 | +```bash |
| 142 | +git tag -a vX.Y.Z -m "Release vX.Y.Z" |
| 143 | +git push origin vX.Y.Z |
| 144 | +``` |
| 145 | + |
| 146 | +Current release trigger from `.github/workflows/release.yml`: |
| 147 | + |
| 148 | +- push tags matching `v*.*.*` |
| 149 | + |
| 150 | +### 9. Verify the GitHub release output |
| 151 | + |
| 152 | +- [ ] Confirm the GitHub release was created |
| 153 | +- [ ] Confirm all expected binaries are attached |
| 154 | +- [ ] Confirm the release body reads well |
| 155 | +- [ ] Edit the release text manually if the generated notes need cleanup or grouping |
| 156 | + |
| 157 | +Expected artifacts: |
| 158 | + |
| 159 | +- Windows: `open-wemo-*-win.exe` |
| 160 | +- macOS ARM: `open-wemo-*-mac` |
| 161 | +- macOS Intel: `open-wemo-*-mac-intel` |
| 162 | +- Linux: `open-wemo-*-linux` |
| 163 | + |
| 164 | +Release note source: |
| 165 | + |
| 166 | +- generated from `git log PREV_TAG..HEAD --pretty=format:"- %s" --no-merges` |
| 167 | + |
| 168 | +### 10. Post-release follow-through |
| 169 | + |
| 170 | +- [ ] Smoke-test one downloaded release artifact from GitHub |
| 171 | +- [ ] Confirm the version shown in shipped binaries matches the tag |
| 172 | +- [ ] Open follow-up issues for anything intentionally deferred |
| 173 | +- [ ] Sync your local branches back to the normal development flow |
| 174 | + |
| 175 | +```bash |
| 176 | +git checkout develop |
| 177 | +git pull origin develop |
| 178 | +``` |
| 179 | + |
| 180 | +## Quick Command Checklist |
| 181 | + |
| 182 | +```bash |
| 183 | +git checkout develop |
| 184 | +git pull origin develop |
| 185 | +git status |
| 186 | +git log --oneline origin/main..HEAD |
| 187 | + |
| 188 | +bun install |
| 189 | +bun run typecheck |
| 190 | +bun run lint |
| 191 | +bun test |
| 192 | +bun run build:linux |
| 193 | + |
| 194 | +git checkout main |
| 195 | +git pull origin main |
| 196 | +git merge develop --no-ff -m "Merge develop for vX.Y.Z" |
| 197 | +git push origin main |
| 198 | + |
| 199 | +git tag -a vX.Y.Z -m "Release vX.Y.Z" |
| 200 | +git push origin vX.Y.Z |
| 201 | +``` |
| 202 | + |
| 203 | +## Repo-Specific Reminders |
| 204 | + |
| 205 | +- Keep commit subjects clean because they become release notes. |
| 206 | +- Bump all three package versions together. |
| 207 | +- Do not tag before CI passes on `main`. |
| 208 | +- If the release includes user-visible behavior changes, update `README.md` in the same release. |
| 209 | +- If the release includes protocol or API behavior changes, update the corresponding files in `docs/` before tagging. |
0 commit comments