docs(oss): describe the release workflow in the Windows build guide (P1.3d)
The guide now says the release workflow builds Windows on windows-latest with NSIS and MSI, and shows how to pack the server archive and run the installer and desktop smoke tests locally.
This commit is contained in:
@@ -5,8 +5,10 @@ branch. The build has to run on Windows: the packaging scripts take the bundled
|
||||
runtime and the native modules (better-sqlite3, onnxruntime) from the machine they run on,
|
||||
so a build made on macOS would ship macOS binaries.
|
||||
|
||||
The community edition has not been built on Windows yet. The first build is part of the
|
||||
week 3 acceptance; record what fails in `docs/oss/upstream-fixes.md` or `docs/oss/baseline.md`.
|
||||
The release workflow (`.github/workflows/release.yml`) runs the same build on GitHub's
|
||||
`windows-latest` runner for every `v*` tag and for pull requests that touch the desktop app.
|
||||
It has not run yet; the first build is part of the week 3 acceptance. Record what fails in
|
||||
`docs/oss/upstream-fixes.md` or `docs/oss/baseline.md`.
|
||||
|
||||
## 1. Prepare the machine
|
||||
|
||||
@@ -74,8 +76,8 @@ copies the native modules, builds the web UI and then the Tauri shell. The first
|
||||
the Rust shell from scratch and takes much longer than later runs.
|
||||
|
||||
`--bundles nsis` builds only the NSIS installer, the one the app is configured for (a
|
||||
per-user install without administrator rights); CI builds the same. Without the flag Tauri
|
||||
also builds an MSI, for which it downloads WiX.
|
||||
per-user install without administrator rights). Without the flag Tauri also builds an MSI,
|
||||
for which it downloads WiX; the release workflow builds both (`--bundles nsis,msi`).
|
||||
|
||||
The installer:
|
||||
|
||||
@@ -83,6 +85,27 @@ The installer:
|
||||
app\src-tauri\target\x86_64-pc-windows-msvc\release\bundle\nsis\Waggle_0.2.0_x64-setup.exe
|
||||
```
|
||||
|
||||
The same staged files make the server archive that the installer tool
|
||||
(`packages/launcher`) installs. To build it and run the release workflow's smoke tests:
|
||||
|
||||
```powershell
|
||||
cd C:\w\waggle-os
|
||||
npm run build --workspace @waggle-ai/waggle
|
||||
node scripts/build-server-archive.mjs
|
||||
node scripts/release-smoke.mjs installer
|
||||
```
|
||||
|
||||
The archive is `artifacts\waggle-server-<version>-windows-x64.tar.gz`. The installer test
|
||||
installs it into a temporary folder, runs `doctor`, starts the server on a free port and
|
||||
uninstalls it.
|
||||
|
||||
After installing the app (section 4), the desktop test starts it, waits until its sidecar
|
||||
answers on port 3333, then stops both. Close Waggle first so the port is free:
|
||||
|
||||
```powershell
|
||||
node scripts/release-smoke.mjs desktop --app "$env:LOCALAPPDATA\Waggle\waggle.exe"
|
||||
```
|
||||
|
||||
## 4. Check the result
|
||||
|
||||
1. Run the installer. It is not signed, so SmartScreen shows "Windows protected your PC":
|
||||
|
||||
Reference in New Issue
Block a user