5.0 KiB
Desktop release and update channel
Squid uses the same release model as nex_shift: a git branch is the update
server. No object storage or release API is required.
Artifact names
Both installers must carry the exact version from src-tauri/tauri.conf.json:
artifacts/Squid-<version>-macOS-universal.dmg
artifacts/Squid-Setup-<version>-win-x64.exe
Additional readmes and checksum files may travel with them, but
scripts/publish-release.sh rejects any other installer-like file. This prevents
an old DMG or stale EXE from silently entering a new release.
macOS
scripts/build-macos-release.sh
The script installs both Apple Rust targets, builds a universal app and DMG,
verifies the code signature and image, then copies the result to the versioned
artifact name. Use --skip-build to re-verify and repackage an existing build.
For distribution outside local testing, replace the ad-hoc identity in
src-tauri/tauri.conf.json with a Developer ID identity and notarize the app.
The CI configuration does not hold Apple credentials.
Windows
On macOS:
pnpm add -g cargo-xwin
scripts/build-windows-release.sh
The script builds the React bundle for the WebView2 target, cross-compiles
x86_64-pc-windows-msvc, checks the PE machine and embedded frontend, then uses
NSIS to produce Squid-Setup-<version>-win-x64.exe.
On Windows, run the same script from Git Bash or MSYS2. It uses the native MSVC
toolchain instead of cargo-xwin. The installer is per-user and installs to:
%LOCALAPPDATA%\Programs\Squid
The executable inside is squid-desktop.exe, matching both the NSIS installer
and the update handoff script.
Signing key
Create the Ed25519 key once, outside the repository:
python3 -m pip install cryptography
python3 scripts/release-key.py keygen ~/.config/squid-release/release.ed25519
Build with the public key so the binary refuses a manifest that is missing or incorrectly signed:
export SQUID_RELEASE_KEY=~/.config/squid-release/release.ed25519
scripts/build-macos-release.sh
scripts/build-windows-release.sh
Both build scripts derive SQUID_UPDATE_PUBKEY from
${SQUID_RELEASE_KEY%.ed25519}.pub. Keep the private key out of git.
Publish
Build both installers first. The publish script rebuilds the releases branch
as one fresh root commit, so old installers never accumulate in history:
scripts/publish-release.sh \
--notes RELEASE_NOTES.md \
--key ~/.config/squid-release/release.ed25519
Useful checks:
scripts/publish-release.sh --dry-run --key ~/.config/squid-release/release.ed25519
scripts/publish-release.sh --no-push --key ~/.config/squid-release/release.ed25519
The branch contains:
squid-update.json
squid-update.sig
Squid-<version>-macOS-universal.dmg
Squid-Setup-<version>-win-x64.exe
Feed URL
src-tauri/build.rs derives the manifest URL from origin:
| Remote | Feed |
|---|---|
| Gitea / Forgejo | https://host/owner/repo/raw/branch/releases/squid-update.json |
| GitHub | https://github.com/owner/repo/raw/releases/squid-update.json |
| GitLab | https://gitlab.example/owner/repo/-/raw/releases/squid-update.json |
SQUID_UPDATE_URL overrides it at build time. The same variable at runtime
overrides the baked value, which is useful for staging feeds:
SQUID_UPDATE_URL=https://host/owner/repo/raw/branch/staging/squid-update.json \
open Squid.app
Manifest
Schema version 1:
{
"schema": 1,
"version": "0.2.0",
"date": "2026-11-03",
"notes": "Release notes shown in Settings.",
"artifacts": {
"macos": {
"file": "Squid-0.2.0-macOS-universal.dmg",
"sha256": "<64 lowercase hex characters>",
"size": 123456789
},
"windows": {
"file": "Squid-Setup-0.2.0-win-x64.exe",
"sha256": "<64 lowercase hex characters>",
"size": 45678901
}
}
}
Windows ARM64 first looks for windows-arm64, then falls back to windows.
Unknown artifact keys are ignored. A larger manifest schema is refused.
Update flow and trust
- The app fetches the manifest from the release branch.
- If the build has a public key,
squid-update.sigmust verify over the manifest's exact bytes. - Version comparison follows semver, including prerelease precedence.
- The platform installer is downloaded to a temporary directory.
- Exact byte size and SHA256 are checked. Any mismatch deletes the download.
- Only a verified file can reach Install and restart.
- The helper waits for Squid to exit, applies the update, and reopens the app.
The signature proves the manifest came from the release key. SHA256 and size prove the downloaded installer is the file that manifest names. HTTPS protects the transport; it is not treated as a substitute for either check.
Version bump
Keep these four values equal:
Cargo.tomlworkspace versionsrc-tauri/Cargo.tomlsrc-tauri/tauri.conf.jsonpackage.json
Then run frontend checks, Rust tests (including src-tauri), build both
installers, and publish.