docs: update README download links and RELEASING.md for v2.1.0 release#9
Conversation
…SING.md Agent-Logs-Url: https://github.com/SynTechRev/ODIA/sessions/336f1d70-5c9c-4712-9ce2-ee3a06adb131 Co-authored-by: SynTechRev <235390103+SynTechRev@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates end-user and maintainer documentation around the upcoming v2.1.0 desktop release, replacing outdated README download guidance and expanding docs/RELEASING.md into a fuller release runbook.
Changes:
- Update
README.md“Desktop App” section with a platform/arch installer table, versioned direct download links, and system requirements. - Expand
docs/RELEASING.mdfrom a short checklist into a detailed automated + manual release process, including troubleshooting and templates.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Replaces build-from-source guidance with release/download-focused instructions and requirements. |
| docs/RELEASING.md | Adds a comprehensive release runbook (steps, fallback process, troubleshooting, checklists, resources). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| cd ../desktop | ||
| npm run build # Create installer for your platform | ||
| ``` | ||
| Download the latest version from the [**Releases page**](https://github.com/SynTechRev/ODIA/releases/latest): |
There was a problem hiding this comment.
The link to /releases/latest will still 404 until at least one non-draft release is published. If this README is intended to work before the first release is created, consider linking to /releases (list page) or explicitly marking this link as only valid after the first release is published.
| Download the latest version from the [**Releases page**](https://github.com/SynTechRev/ODIA/releases/latest): | |
| Download the latest version from the [**Releases page**](https://github.com/SynTechRev/ODIA/releases): |
| | **macOS** | `ODIA-2.1.0.dmg` | x64, arm64 (Universal) | | ||
| | **Linux** | `ODIA-2.1.0.AppImage` | x64 | | ||
|
|
||
| **Direct download links (after v2.1.0 release):** | ||
| - [Windows x64](https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-Setup-2.1.0.exe) | ||
| - [macOS Universal](https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-2.1.0.dmg) |
There was a problem hiding this comment.
The macOS row/linking assumes a single “Universal” DMG (ODIA-2.1.0.dmg), but the current electron-builder config builds separate x64 and arm64 artifacts (not a combined universal DMG). This will make the architecture info and direct download link inaccurate for Apple Silicon. Either update the docs to list both DMGs (and their filenames/links), or update the build config to produce a true universal artifact.
| | **macOS** | `ODIA-2.1.0.dmg` | x64, arm64 (Universal) | | |
| | **Linux** | `ODIA-2.1.0.AppImage` | x64 | | |
| **Direct download links (after v2.1.0 release):** | |
| - [Windows x64](https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-Setup-2.1.0.exe) | |
| - [macOS Universal](https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-2.1.0.dmg) | |
| | **macOS** | Separate DMGs on the Releases page | x64 (Intel), arm64 (Apple Silicon) | | |
| | **Linux** | `ODIA-2.1.0.AppImage` | x64 | | |
| **Direct download links (after v2.1.0 release):** | |
| - [Windows x64](https://github.com/SynTechRev/ODIA/releases/download/v2.1.0/ODIA-Setup-2.1.0.exe) | |
| - [macOS (choose Intel x64 or Apple Silicon arm64 asset)](https://github.com/SynTechRev/ODIA/releases/tag/v2.1.0) |
| - Verify three installers are attached: | ||
| - `ODIA-Setup-X.Y.Z.exe` (Windows) | ||
| - `ODIA-X.Y.Z.dmg` (macOS) | ||
| - `ODIA-X.Y.Z.AppImage` (Linux) | ||
| - Test download links work | ||
| - Download and test installers on each platform | ||
| - Download and test installers (recommended) | ||
|
|
||
| ### What the Workflow Does | ||
|
|
||
| The `.github/workflows/release-desktop.yml` workflow: | ||
|
|
||
| 1. **Builds Python backend** using PyInstaller | ||
| 2. **Builds frontend** as static export for Electron | ||
| 3. **Creates native installers** using electron-builder: | ||
| - **Windows:** NSIS installer (`.exe`) | ||
| - **macOS:** DMG disk image (`.dmg`) - Universal binary (x64 + arm64) | ||
| - **Linux:** AppImage (`.AppImage`) |
There was a problem hiding this comment.
This section states macOS produces a “Universal binary (x64 + arm64)” and implies only one .dmg, but desktop/package.json is configured to build two separate DMGs (x64 and arm64). The release verification checklist should reflect the actual set of assets (e.g., both DMGs) or the build config should be changed to generate a universal DMG.
| - `pyproject.toml` (line 7) | ||
| - `desktop/package.json` (line 3) |
There was a problem hiding this comment.
The prerequisites list hard-codes line numbers for pyproject.toml and desktop/package.json. These will drift over time and can mislead readers; consider removing the line references or linking to the files/keys instead.
| - `pyproject.toml` (line 7) | |
| - `desktop/package.json` (line 3) | |
| - `pyproject.toml` | |
| - `desktop/package.json` |
README download section pointed to non-existent release assets using
/latest/download/URLs, which 404 since no release exists yet. Release documentation was minimal.README.md
/download/v2.1.0/pathsdocs/RELEASING.md
Workflow
.github/workflows/release-desktop.ymlalready has correctcontents: writepermissions andv*.*.*tag trigger — no changes needed.