Skip to content

Commit 1feda7f

Browse files
committed
docs: add release checklist to standardize versioning process
1 parent 6270d56 commit 1feda7f

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

RELEASE_CHECKLIST.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# 🚀 Release Checklist: Omnitool
2+
3+
Follow these steps rigorously before pushing a new version tag (e.g., `v0.1.2`).
4+
5+
## 1. Code Quality & Stability
6+
- [ ] Run backend tests: `cd omnitool/src-tauri && cargo test`
7+
- [ ] Run frontend tests: `cd omnitool && npm run test`
8+
- [ ] Run production build locally: `cd omnitool && npm run build`
9+
- [ ] Clean up `console.log` statements and unused imports (`npm run build` will catch these).
10+
11+
## 2. Version Synchronization
12+
- [ ] Update version in `omnitool/src-tauri/Cargo.toml`
13+
- [ ] Update version in `omnitool/src-tauri/tauri.conf.json`
14+
- [ ] Update hardcoded version in `omnitool/src/App.tsx` (sidebar footer).
15+
16+
## 3. Homebrew Tap (External)
17+
- [ ] Update version in your `homebrew-tap` repo (`Casks/omnitool.rb`).
18+
- [ ] Verify the download URLs in the Ruby file match the new tag.
19+
20+
## 4. Distribution & Landing Page
21+
- [ ] Update version badge in `README.md`.
22+
- [ ] Update "Latest Release" links in `landing-page/index.html`.
23+
- [ ] Update the "Features" section if new tools were added.
24+
25+
## 5. Deployment
26+
- [ ] Commit all changes: `git add . && git commit -m "chore: prepare for vX.Y.Z release"`
27+
- [ ] Push to main: `git push origin main`
28+
- [ ] Create and push tag: `git tag vX.Y.Z && git push origin vX.Y.Z`
29+
- [ ] Verify GitHub Actions build success for all platforms (Windows, macOS, Linux).
30+
31+
---
32+
*Note: This checklist ensures we never have a "version desync" error again.*

0 commit comments

Comments
 (0)