From 7830b3c5e89f0339949940b8986bf4849ad7f223 Mon Sep 17 00:00:00 2001 From: salmonik Date: Sun, 1 Nov 2026 21:35:30 +0100 Subject: v4.3.0: package the desktop app with verifiable installers publish.sh builds the GUI with the gui-release profile, names it zagan-bet-gui---, and renders a bash and a PowerShell installer next to each app. Both embed the app's SHA-256, verify the file (or fetch it), install per-user and add a launcher: a desktop entry plus an SVG icon on Linux, a Start-menu shortcut on Windows. The download page gains a Desktop app section with the apps and installers, keeps the terminal client and server, links the public git repository for the GPL source, and lists every file in the sha256sum block. deploy.sh verifies all four artifact kinds. Publishing refuses a dirty tree so the linked history matches the binaries. --- AGENTS.md | 6 +++ Cargo.toml | 2 +- docs/GUI-PLAN.md | 31 +++++++++++----- docs/TESTING.md | 17 +++++++++ gui/Cargo.toml | 2 +- gui/assets/zagan-bet.svg | 6 +++ scripts/deploy.sh | 9 ++++- scripts/installers/linux.sh.in | 78 +++++++++++++++++++++++++++++++++++++++ scripts/installers/windows.ps1.in | 75 +++++++++++++++++++++++++++++++++++++ scripts/publish.sh | 66 +++++++++++++++++++++++++++++++-- scripts/render-installer.py | 49 ++++++++++++++++++++++++ web/README.md | 43 +++++++++++++++------ web/index.php | 78 +++++++++++++++++++++++++++++++-------- 13 files changed, 416 insertions(+), 46 deletions(-) create mode 100644 gui/assets/zagan-bet.svg create mode 100644 scripts/installers/linux.sh.in create mode 100644 scripts/installers/windows.ps1.in create mode 100644 scripts/render-installer.py diff --git a/AGENTS.md b/AGENTS.md index 368a348..7258710 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -85,6 +85,12 @@ - The embedded fonts have no suit or arrow glyphs. Draw card suits as shapes and use plain words for navigation; a glyph that is not in Open Sans or Hack renders as tofu. +- `scripts/publish.sh` builds the GUI with `gui-release` and renders the + installers with the published SHA-256. Installers verify the hash and install + per-user; never install system-wide or skip the check. +- The download page links the public git repository + (https://git.2137697.xyz/zagan-bet.git) for the GPL corresponding source. + Run publish from a clean tree so the linked history matches the binaries. ## Client TUI - `render_lines()` and `render()` must agree. If `render()` uses `\r\n`, diff --git a/Cargo.toml b/Cargo.toml index 179cb39..22a6ec7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ members = ["gui"] [package] name = "zagan-bet" -version = "4.2.1" +version = "4.3.0" edition = "2024" license = "GPL-3.0-or-later" diff --git a/docs/GUI-PLAN.md b/docs/GUI-PLAN.md index 89cf495..f058e41 100644 --- a/docs/GUI-PLAN.md +++ b/docs/GUI-PLAN.md @@ -162,17 +162,28 @@ Measured on Linux at 1080p with llvmpipe software GL: **Gate:** the screenshot set is ready for review. Remaining for the gate: frame rate on integrated graphics and the Windows interactive pass. -## Phase 5 — packaging -## Phase 5 — packaging - -- `publish.sh` emits `zagan-bet-gui---[.exe]`. -- Bash and PowerShell installers that verify the SHA-256, install to the user - directory, and create `.desktop`/Start-menu entries. -- Download page lists raw binaries and installers; add the source-code link. - -**Gate:** `deploy.sh` verifies both artifact kinds; a clean machine installs -from the page and launches. +## Phase 5 — packaging (code complete, v4.3.0) + +- `publish.sh` builds the GUI with the `gui-release` profile for Linux and + Windows and names the app `zagan-bet-gui---[.exe]`. +- It renders a bash installer and a PowerShell installer next to each app. + Both embed the app's SHA-256, verify the file (or download it), install + per-user and add a launcher: `.desktop` plus an SVG icon on Linux, a + Start-menu shortcut on Windows. Templates live in `scripts/installers/`; + `render-installer.py` fills them in. +- The download page scans `bin/gui`, `bin/client` and `bin/server`, lists + apps, installers, clients and servers, and includes every file in the + `sha256sum` block. A Source section links the public git repository + () for the GPL corresponding source. + `deploy.sh` verifies every artifact kind over the public URL. +- `publish.sh` refuses to run from a dirty tree so the linked history matches + the binaries. + +**Gate:** deploy verification passes for apps, installers, clients and +servers; the Linux installer is exercised in a clean HOME. The Windows +installer needs a Windows machine before the gate closes. +## Testing split ## Testing split - `View`/`Command` tests in the core: flows, gating, state. Always. diff --git a/docs/TESTING.md b/docs/TESTING.md index 613cd08..c32ac22 100644 --- a/docs/TESTING.md +++ b/docs/TESTING.md @@ -266,3 +266,20 @@ terminal client; a saved login from one signs in the other. the row is upgraded to bcrypt. - Spin several times and confirm `plays` grows by one row per spin while `users.balance` changes by `winnings - bet`. + +## Packaging checklist + +1. Set the version in `Cargo.toml` and `gui/Cargo.toml` (same MAJOR.MINOR), + run `cargo test --workspace`, and commit. `publish.sh` refuses a dirty tree + because the site links the committed git history as the GPL source. +2. `./scripts/publish.sh` (add `DEST=` and `URL_BASE=` to stage elsewhere). It + builds the GUI with `gui-release`, the terminal clients and servers, and + renders the bash/PowerShell installers with each app's SHA-256. +3. `php -S 127.0.0.1:8899 -t ` and + `./scripts/deploy.sh http://127.0.0.1:8899/` to upload and verify + every app, installer, client and server against the page's checksums. +4. On a clean user account: download an app with its installer, run the + installer, and launch the new menu entry. The installer must refuse a + corrupted download. +5. Repeat on Windows for the `.ps1` installer and the Start-menu shortcut. + diff --git a/gui/Cargo.toml b/gui/Cargo.toml index 5418794..8bcbda0 100644 --- a/gui/Cargo.toml +++ b/gui/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zagan-bet-gui" -version = "4.2.1" +version = "4.3.0" edition = "2024" license = "GPL-3.0-or-later" description = "Desktop frontend for zagan-bet" diff --git a/gui/assets/zagan-bet.svg b/gui/assets/zagan-bet.svg new file mode 100644 index 0000000..74e5a3a --- /dev/null +++ b/gui/assets/zagan-bet.svg @@ -0,0 +1,6 @@ + + + + + diff --git a/scripts/deploy.sh b/scripts/deploy.sh index 99129ad..b18d462 100755 --- a/scripts/deploy.sh +++ b/scripts/deploy.sh @@ -1,5 +1,6 @@ #!/usr/bin/env bash -# Upload web/ and verify every published artifact over the public URL. +# Upload web/ and verify every published artifact (GUI app and installers, +# terminal client and server) over the public URL. # # Usage: # ./scripts/deploy.sh user@host:/srv/zagan.bet https://zagan.bet/ @@ -50,7 +51,11 @@ done [ -f web/index.php ] || die "web/index.php is missing" shopt -s nullglob -artifacts=(web/bin/client/zagan-bet-* web/bin/server/zagan-bet-*) +artifacts=( + web/bin/gui/zagan-bet-* + web/bin/client/zagan-bet-* + web/bin/server/zagan-bet-* +) shopt -u nullglob [ ${#artifacts[@]} -gt 0 ] || die "no artifacts in web/bin; run scripts/publish.sh first" diff --git a/scripts/installers/linux.sh.in b/scripts/installers/linux.sh.in new file mode 100644 index 0000000..5b53c02 --- /dev/null +++ b/scripts/installers/linux.sh.in @@ -0,0 +1,78 @@ +#!/usr/bin/env bash +# Zagan-Bet desktop installer for Linux. +# +# Verifies the app against its published SHA-256, installs it for the current +# user and adds a launcher. Put the downloaded app next to this script, or run +# the script on its own and it will fetch the matching binary. +set -euo pipefail + +VERSION="__VERSION__" +BINARY="__BINARY__" +SHA256="__SHA256__" +URL="__URL__" + +say() { printf '%s\n' "$*"; } +die() { printf 'install: %s\n' "$*" >&2; exit 1; } + +command -v sha256sum >/dev/null 2>&1 || die "sha256sum is required" + +here=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) +source_file="" +for candidate in "$here/$BINARY" "./$BINARY" "$HOME/Downloads/$BINARY"; do + if [ -f "$candidate" ]; then + source_file=$candidate + break + fi +done + +cleanup="" +if [ -z "$source_file" ]; then + command -v curl >/dev/null 2>&1 || die "put $BINARY next to this installer, or install curl" + cleanup=$(mktemp) || die "cannot create a temporary file" + say "Downloading $BINARY..." + curl -fsSL --max-time 300 "$URL" -o "$cleanup" || die "download failed" + source_file=$cleanup +fi +trap 'if [ -n "$cleanup" ]; then rm -f "$cleanup"; fi' EXIT + +actual=$(sha256sum "$source_file" | awk '{print $1}') +[ "$actual" = "$SHA256" ] || die "checksum mismatch: expected $SHA256, got $actual" + +bin_dir="${XDG_BIN_HOME:-$HOME/.local/bin}" +data_dir="${XDG_DATA_HOME:-$HOME/.local/share}" +app="$bin_dir/zagan-bet-gui" +desktop_dir="$data_dir/applications" +icon_dir="$data_dir/icons/hicolor/scalable/apps" + +mkdir -p "$bin_dir" "$desktop_dir" "$icon_dir" +install -m 0755 "$source_file" "$app" + +cat > "$icon_dir/zagan-bet.svg" <<'ICON' +__ICON__ +ICON + +cat > "$desktop_dir/zagan-bet.desktop" </dev/null 2>&1; then + update-desktop-database "$desktop_dir" >/dev/null 2>&1 || true +fi +if command -v gtk-update-icon-cache >/dev/null 2>&1; then + gtk-update-icon-cache -q "$data_dir/icons/hicolor" >/dev/null 2>&1 || true +fi + +say "Installed Zagan-Bet $VERSION to $app" +say "A launcher was added to your applications menu." +case ":$PATH:" in + *":$bin_dir:"*) ;; + *) say "Add $bin_dir to PATH to start it as 'zagan-bet-gui'." ;; +esac diff --git a/scripts/installers/windows.ps1.in b/scripts/installers/windows.ps1.in new file mode 100644 index 0000000..fd2b8b3 --- /dev/null +++ b/scripts/installers/windows.ps1.in @@ -0,0 +1,75 @@ +# Zagan-Bet desktop installer for Windows. +# +# Verifies the app against its published SHA-256, installs it for the current +# user and adds a Start-menu shortcut. Put the downloaded app next to this +# script, or run the script on its own and it will fetch the matching binary. +# +# Run it with: +# powershell -ExecutionPolicy Bypass -File .\zagan-bet-gui-*-install.ps1 +$ErrorActionPreference = "Stop" + +$Version = "__VERSION__" +$Binary = "__BINARY__" +$Sha256 = "__SHA256__" +$Url = "__URL__" + +function Stop-Install([string]$Message) { + Write-Host "install: $Message" -ForegroundColor Red + exit 1 +} + +$here = Split-Path -Parent $MyInvocation.MyCommand.Path +$candidates = @( + (Join-Path $here $Binary), + (Join-Path (Get-Location) $Binary), + (Join-Path $env:USERPROFILE "Downloads\$Binary") +) +$sourceFile = $null +foreach ($candidate in $candidates) { + if (Test-Path -LiteralPath $candidate) { + $sourceFile = $candidate + break + } +} + +$temporary = $null +if (-not $sourceFile) { + $temporary = Join-Path ([System.IO.Path]::GetTempPath()) $Binary + Write-Host "Downloading $Binary..." + try { + Invoke-WebRequest -Uri $Url -OutFile $temporary -UseBasicParsing + } catch { + Stop-Install "download failed: $_" + } + $sourceFile = $temporary +} + +try { + $actual = (Get-FileHash -LiteralPath $sourceFile -Algorithm SHA256).Hash.ToLowerInvariant() + if ($actual -ne $Sha256.ToLowerInvariant()) { + Stop-Install "checksum mismatch: expected $Sha256, got $actual" + } + + $installDir = Join-Path $env:LOCALAPPDATA "Programs\Zagan-Bet" + New-Item -ItemType Directory -Force -Path $installDir | Out-Null + $target = Join-Path $installDir "zagan-bet-gui.exe" + Copy-Item -LiteralPath $sourceFile -Destination $target -Force + + $startMenu = Join-Path $env:APPDATA "Microsoft\Windows\Start Menu\Programs" + New-Item -ItemType Directory -Force -Path $startMenu | Out-Null + $shortcutPath = Join-Path $startMenu "Zagan-Bet.lnk" + $shell = New-Object -ComObject WScript.Shell + $shortcut = $shell.CreateShortcut($shortcutPath) + $shortcut.TargetPath = $target + $shortcut.WorkingDirectory = $installDir + $shortcut.IconLocation = "$target,0" + $shortcut.Description = "Slots, roulette, blackjack and crash" + $shortcut.Save() + + Write-Host "Installed Zagan-Bet $Version to $target" + Write-Host "A Start-menu shortcut was created." +} finally { + if ($temporary -and (Test-Path -LiteralPath $temporary)) { + Remove-Item -LiteralPath $temporary -Force + } +} diff --git a/scripts/publish.sh b/scripts/publish.sh index 8240859..3a04631 100755 --- a/scripts/publish.sh +++ b/scripts/publish.sh @@ -3,14 +3,22 @@ # download page expects: # # zagan-bet-client---[.exe] -# zagan-bet-server--- +# zagan-bet-server---[.exe] +# zagan-bet-gui---[.exe] +# zagan-bet-gui----install.sh +# zagan-bet-gui----install.ps1 # -# Cargo always writes target//release/, so the rename happens here -# after each build. The version comes from Cargo.toml. +# Cargo always writes target///, so the rename happens +# here after each build. The version comes from Cargo.toml. +# +# The GUI uses the workspace's `gui-release` profile (small, stripped, LTO). +# The public git repository is the GPL source for these binaries, so publish +# from a clean tree (or set ALLOW_DIRTY=1 for a preview). # # Usage: # ./scripts/publish.sh # DEST=/srv/www/bin ./scripts/publish.sh +# URL_BASE=https://staging.example/ ./scripts/publish.sh set -euo pipefail ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd) @@ -23,6 +31,21 @@ if [ -z "${VERSION:-}" ]; then fi DEST=${DEST:-web/bin} +URL_BASE=${URL_BASE:-https://zagan.2137697.xyz} + +if [ "${ALLOW_DIRTY:-0}" != "1" ] && [ -n "$(git status --porcelain)" ]; then + echo "the working tree is dirty; commit the release first (or ALLOW_DIRTY=1)" >&2 + exit 1 +fi + +command -v python3 >/dev/null || { + echo "python3 is required to render the installers" >&2 + exit 1 +} + +hash_of() { + sha256sum "$1" | awk '{print $1}' +} publish() { local triple=$1 kind=$2 platform=$3 arch=$4 @@ -47,11 +70,46 @@ publish() { echo " $DEST/$kind/$artifact ($(du -h "$DEST/$kind/$artifact" | cut -f1))" } +publish_gui() { + local triple=$1 platform=$2 arch=$3 + local ext="" + if [ "$platform" = windows ]; then + ext=".exe" + fi + + local artifact="zagan-bet-gui-$VERSION-$platform-$arch$ext" + local source="target/$triple/gui-release/zagan-bet-gui$ext" + + echo "==> $artifact" + cargo build -p zagan-bet-gui --profile gui-release --quiet --target "$triple" + + mkdir -p "$DEST/gui" + install -m 0755 "$source" "$DEST/gui/$artifact" + local sha + sha=$(hash_of "$DEST/gui/$artifact") + echo " $DEST/gui/$artifact ($(du -h "$DEST/gui/$artifact" | cut -f1))" + + if [ "$platform" = linux ]; then + python3 scripts/render-installer.py \ + scripts/installers/linux.sh.in \ + "$DEST/gui/zagan-bet-gui-$VERSION-linux-$arch-install.sh" \ + "$VERSION" "$artifact" "$sha" "$URL_BASE/bin/gui/$artifact" + elif [ "$platform" = windows ]; then + python3 scripts/render-installer.py \ + scripts/installers/windows.ps1.in \ + "$DEST/gui/zagan-bet-gui-$VERSION-windows-$arch-install.ps1" \ + "$VERSION" "$artifact" "$sha" "$URL_BASE/bin/gui/$artifact" + fi +} + +publish_gui x86_64-unknown-linux-gnu linux x86_64 +publish_gui x86_64-pc-windows-gnu windows x86_64 + publish x86_64-unknown-linux-gnu client linux x86_64 publish i686-unknown-linux-gnu client linux i686 publish x86_64-pc-windows-gnu client windows x86_64 publish x86_64-unknown-linux-gnu server linux x86_64 -publish x86_64-pc-windows-gnu server windows x86_64 +publish x86_64-pc-windows-gnu server windows x86_64 echo echo "published $VERSION to $DEST" diff --git a/scripts/render-installer.py b/scripts/render-installer.py new file mode 100644 index 0000000..1a00551 --- /dev/null +++ b/scripts/render-installer.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python3 +"""Fill an installer template with one published artifact's details. + +Usage: render-installer.py