From 03d53551f462a5bcad9d2e7800e5080e0c1eb1b7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 13 Apr 2026 18:25:10 +0000 Subject: [PATCH 1/2] Initial plan From 77349ecad931f7e8f7f621d5e8ec65762d5807e2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 13 Apr 2026 18:27:44 +0000 Subject: [PATCH 2/2] Add RELEASE_CHECKLIST.md and RELEASE_NOTES_TEMPLATE.md to docs/ Agent-Logs-Url: https://github.com/SynTechRev/ODIA/sessions/43b92564-ea44-48a5-b672-54ee78c1dc02 Co-authored-by: SynTechRev <235390103+SynTechRev@users.noreply.github.com> --- docs/RELEASE_CHECKLIST.md | 84 ++++++++++++++++++++++++++++++++++ docs/RELEASE_NOTES_TEMPLATE.md | 52 +++++++++++++++++++++ 2 files changed, 136 insertions(+) create mode 100644 docs/RELEASE_CHECKLIST.md create mode 100644 docs/RELEASE_NOTES_TEMPLATE.md diff --git a/docs/RELEASE_CHECKLIST.md b/docs/RELEASE_CHECKLIST.md new file mode 100644 index 0000000..adede27 --- /dev/null +++ b/docs/RELEASE_CHECKLIST.md @@ -0,0 +1,84 @@ +# ODIA Release Checklist + +## Pre-Release Validation + +- [ ] All tests passing on master +- [ ] Version numbers synchronized: + - [ ] `pyproject.toml` version matches + - [ ] `desktop/package.json` version matches +- [ ] CHANGELOG.md updated (if exists) +- [ ] Desktop app icons present in `desktop/resources/` +- [ ] README.md download links point to correct version + +## Release Process + +### 1. Create Release Tag + +```bash +git checkout master +git pull origin master +git tag -a v2.1.0 -m "Release message here" +git push origin v2.1.0 +``` + +### 2. Monitor Automated Build + +- Go to: https://github.com/SynTechRev/ODIA/actions +- Watch "Build and Release Desktop Apps" workflow +- Expected duration: ~20 minutes +- 4 parallel jobs should complete successfully + +### 3. Verify Release Artifacts + +Release should be created at: https://github.com/SynTechRev/ODIA/releases/tag/v2.1.0 + +Expected artifacts: +- [ ] ODIA-Setup-2.1.0.exe (~180 MB) +- [ ] ODIA-2.1.0-x64.dmg (~200 MB) +- [ ] ODIA-2.1.0-arm64.dmg (~195 MB) +- [ ] ODIA-2.1.0.AppImage (~175 MB) + +### 4. Test Download Links + +Verify these URLs return actual files: +- https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-Setup-2.1.0.exe +- https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-2.1.0-x64.dmg +- https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-2.1.0-arm64.dmg +- https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-2.1.0.AppImage + +### 5. Manual Testing (Recommended) + +- [ ] Download Windows installer and verify it installs +- [ ] Download macOS DMG and verify it opens +- [ ] Download Linux AppImage and verify it executes +- [ ] Test app launches on each platform +- [ ] Verify analysis functionality works offline + +### 6. Post-Release + +- [ ] Mark release as "Latest release" (usually automatic) +- [ ] Announce release (optional) +- [ ] Close related issues/PRs +- [ ] Plan next version features + +## Troubleshooting + +### Build Fails + +1. Check workflow logs: https://github.com/SynTechRev/ODIA/actions +2. Common issues: + - npm ci errors → verify package-lock.json exists + - Python dependencies → check requirements.txt + - Platform-specific errors → review runner logs + +### Release Not Created + +- Verify tag was pushed: `git ls-remote --tags origin` +- Check tag format matches `v*.*.*` pattern +- Ensure workflow has `contents: write` permission + +### Installers Missing + +- Check if workflow completed all 4 jobs +- Verify artifact upload succeeded +- Check file patterns in release-desktop.yml match actual output diff --git a/docs/RELEASE_NOTES_TEMPLATE.md b/docs/RELEASE_NOTES_TEMPLATE.md new file mode 100644 index 0000000..692829a --- /dev/null +++ b/docs/RELEASE_NOTES_TEMPLATE.md @@ -0,0 +1,52 @@ +# Release Notes Template + +Use this template when creating release tags: + +## Version X.Y.Z + +### New Features +- List new features here +- Be specific about user-facing improvements + +### Improvements +- Performance enhancements +- UI/UX improvements +- Documentation updates + +### Bug Fixes +- List bugs fixed in this release +- Reference issue numbers when applicable + +### Breaking Changes +- Document any breaking changes +- Provide migration instructions + +### Known Issues +- List any known issues +- Provide workarounds if available + +### Technical Details +- Dependencies updated +- Build system changes +- Internal refactoring + +### Downloads + +| Platform | File | Size | +|----------|------|------| +| Windows (x64) | ODIA-Setup-X.Y.Z.exe | ~XXX MB | +| macOS (Intel) | ODIA-X.Y.Z-x64.dmg | ~XXX MB | +| macOS (Apple Silicon) | ODIA-X.Y.Z-arm64.dmg | ~XXX MB | +| Linux (x64) | ODIA-X.Y.Z.AppImage | ~XXX MB | + +### Installation Instructions + +See [desktop/README.md](../desktop/README.md) for platform-specific installation instructions. + +### Verification + +All installers are signed with SHA-256 checksums. Verify downloads: + +```bash +sha256sum ODIA-* +```