323 lines
16 KiB
YAML
323 lines
16 KiB
YAML
# Every push to main is a release candidate (docs/desktop-release.md, "Release candidates"). In parallel:
|
|
# ci bun run ci (adapters, desktop version, tests, typecheck, desktop i18n / typecheck / build, the boot check
|
|
# in headless Chromium, desktop Rust tests and clippy, scrub); tools/ci.ts runs it as a task graph with
|
|
# parallel test shards on the one Linux runner. CI=full runs the Rust steps on every push.
|
|
# acceptance the release acceptance matrix (tools/acceptance.ts): every user-facing command from the packed npm
|
|
# tarball with real piped stdin, Linux and Windows x Node 20 / Node 22 / Bun.
|
|
# linux AppImage + deb (path-free build), self-tests, both started under Xvfb, privacy scan.
|
|
# windows NSIS installer, silent per-user install, self-test, uninstall, the Node prompt smoke, privacy scan.
|
|
# record when all are green: the draft release rc-<sha> with the installers, the acceptance runs and matrix and
|
|
# green.json (tools/release-candidate.ts record). A v* tag on this commit only promotes it (release.yml).
|
|
# gate decides first: a commit that differs from its green parent only in version copies + CHANGELOG (a release's
|
|
# version bump, proven file by file: tools/release-candidate.ts gate) reuses the parent's ci and acceptance results
|
|
# and builds only the installers, whose embedded version changed.
|
|
# Pull requests run ci + acceptance (no installers, no record). rehearsal/* branches are release rehearsals
|
|
# (tools/release.ts --rehearsal). site/ is still published by Jenkins.
|
|
name: ci
|
|
|
|
on:
|
|
push:
|
|
branches: [main, 'rehearsal/**']
|
|
pull_request:
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
|
|
env:
|
|
BUN_VERSION: '1.4.0'
|
|
CARGO_TERM_COLOR: never
|
|
CARGO_INCREMENTAL: '0'
|
|
CI: full
|
|
|
|
jobs:
|
|
gate:
|
|
runs-on: ubuntu-22.04
|
|
# the self-hosted runners only run code from this repo: pull requests from forks are skipped
|
|
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
|
|
timeout-minutes: 45
|
|
outputs:
|
|
reuse: ${{ steps.gate.outputs.reuse }}
|
|
from: ${{ steps.gate.outputs.from }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 2
|
|
- name: Version-only commit of a green parent?
|
|
id: gate
|
|
env:
|
|
FORGEJO_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
|
FORGEJO_URL: ${{ github.server_url }}
|
|
FORGEJO_ORIGIN: ${{ secrets.FORGEJO_ORIGIN }}
|
|
EVENT: ${{ github.event_name }}
|
|
SHA: ${{ github.sha }}
|
|
run: |
|
|
if [ "$EVENT" = pull_request ]; then echo "reuse=false" >> "$GITHUB_OUTPUT"; echo "pull request: everything runs"; exit 0; fi
|
|
curl -fsSL https://bun.sh/install | bash -s "bun-v${BUN_VERSION}" >/dev/null
|
|
export PATH="$HOME/.bun/bin:$PATH"
|
|
bun tools/release-candidate.ts gate --sha "$SHA" --wait 40
|
|
|
|
ci:
|
|
needs: gate
|
|
if: needs.gate.outputs.reuse != 'true'
|
|
# runner label: ubuntu-22.04:docker://ghcr.io/catthehacker/ubuntu:act-22.04
|
|
runs-on: ubuntu-22.04
|
|
timeout-minutes: 60
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: ./.forgejo/actions/linux-setup
|
|
with:
|
|
cache-key: ci
|
|
rust-components: clippy
|
|
- uses: ./.forgejo/actions/ci-run
|
|
|
|
# The release acceptance matrix (tools/acceptance.ts, docs/acceptance.md): every user-facing command from the packed
|
|
# npm tarball, in fresh temp folders with piped stdin and the fake stores, on Linux and Windows x Node 20 / Node 22
|
|
# (npx --package=<tgz>) / Bun (bun x). One red cell and the commit is no candidate. macOS runs on the owner's Mac
|
|
# (tools/release.ts, cached per CLI key).
|
|
acceptance:
|
|
needs: gate
|
|
if: needs.gate.outputs.reuse != 'true'
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- { os: ubuntu-22.04, platform: Linux, runtime: node, node: '20', name: node20 }
|
|
- { os: ubuntu-22.04, platform: Linux, runtime: node, node: '22', name: node22 }
|
|
- { os: ubuntu-22.04, platform: Linux, runtime: bun, node: '22', name: bun }
|
|
- { os: windows, platform: Windows, runtime: node, node: '20', name: node20 }
|
|
- { os: windows, platform: Windows, runtime: node, node: '22', name: node22 }
|
|
- { os: windows, platform: Windows, runtime: bun, node: '22', name: bun }
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 45
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: ${{ matrix.node }}
|
|
- name: Bun (Linux)
|
|
if: ${{ matrix.platform == 'Linux' }}
|
|
shell: bash
|
|
run: |
|
|
curl -fsSL https://bun.sh/install | bash -s "bun-v${BUN_VERSION}" >/dev/null
|
|
echo "$HOME/.bun/bin" >> "${FORGEJO_PATH:-$GITHUB_PATH}"
|
|
- name: Acceptance matrix (Linux)
|
|
if: ${{ matrix.platform == 'Linux' }}
|
|
shell: bash
|
|
run: |
|
|
node --version && bun --version
|
|
bun tools/acceptance.ts run --runtime ${{ matrix.runtime }} --platform Linux --jobs 4 --out acceptance/Linux-${{ matrix.name }}.json
|
|
- name: Acceptance matrix (Windows)
|
|
if: ${{ matrix.platform == 'Windows' }}
|
|
shell: pwsh
|
|
run: |
|
|
node --version; bun --version
|
|
bun tools/acceptance.ts run --runtime ${{ matrix.runtime }} --platform Windows --jobs 3 --out acceptance/Windows-${{ matrix.name }}.json
|
|
if ($LASTEXITCODE -ne 0) { throw "acceptance matrix: red cells" }
|
|
- uses: actions/upload-artifact@v3
|
|
if: ${{ always() }}
|
|
with:
|
|
name: acceptance-${{ matrix.platform }}-${{ matrix.name }}
|
|
path: acceptance/
|
|
retention-days: 14
|
|
|
|
linux:
|
|
needs: gate
|
|
if: github.event_name != 'pull_request'
|
|
# runner label: ubuntu-22.04:docker://ghcr.io/catthehacker/ubuntu:act-22.04 (glibc 2.35: the AppImage and the
|
|
# deb then run on Ubuntu 22.04 and newer, Debian 12)
|
|
runs-on: ubuntu-22.04
|
|
timeout-minutes: 90
|
|
env:
|
|
# the path-free build keeps the target folder outside every home folder
|
|
CARGO_TARGET_DIR: /tmp/storebound-target
|
|
# linuxdeploy (AppImage) runs without FUSE inside the container
|
|
APPIMAGE_EXTRACT_AND_RUN: '1'
|
|
# linuxdeploy must not strip: the storebound sidecar is a `bun build --compile` executable whose JS payload strip
|
|
# removes (it then starts as plain bun). The Rust binary is already stripped by Cargo (profile.release strip).
|
|
NO_STRIP: '1'
|
|
# WebKitGTK's DMABUF renderer leaves the window blank on some GPU / VM setups; the app sets this itself at
|
|
# start (src-tauri/src/lib.rs linux_webkit_env) unless the user did; set here too for anything run in CI
|
|
WEBKIT_DISABLE_DMABUF_RENDERER: '1'
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: ./.forgejo/actions/linux-setup
|
|
with:
|
|
cache-key: desktop
|
|
packages: patchelf file squashfs-tools p7zip-full xz-utils
|
|
# the release target folder (dependencies compiled once; a version bump recompiles only the app crate)
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: /tmp/storebound-target
|
|
key: desktop-target-${{ runner.os }}-${{ hashFiles('apps/desktop/src-tauri/Cargo.lock') }}
|
|
restore-keys: desktop-target-${{ runner.os }}-
|
|
- name: Install and check
|
|
run: |
|
|
bun install --frozen-lockfile
|
|
bun tools/desktop-version.ts
|
|
bun tools/build-sidecars.ts --target bun-linux-x64
|
|
# linuxdeploy (AppImage) sets the rpath of every executable with its own patchelf, which corrupts the bun
|
|
# sidecar (segfault, then ldd fails in the gtk plugin). With the rpath already set (Ubuntu's patchelf, which
|
|
# keeps it working), linuxdeploy leaves the file as it is. The sidecar needs only libc, so the rpath is inert.
|
|
patchelf --set-rpath '$ORIGIN/../lib' apps/desktop/src-tauri/binaries/storebound-x86_64-unknown-linux-gnu
|
|
apps/desktop/src-tauri/binaries/storebound-x86_64-unknown-linux-gnu version
|
|
- name: Build AppImage and deb (path-free)
|
|
working-directory: apps/desktop
|
|
run: |
|
|
rm -rf "$CARGO_TARGET_DIR/release/bundle"
|
|
bun ../../tools/desktop-release.ts exec -- bunx tauri build --bundles appimage,deb --ci
|
|
- name: Self-test the exact artifacts
|
|
run: |
|
|
V=$(bun tools/desktop-version.ts --print)
|
|
B="$CARGO_TARGET_DIR/release/bundle"
|
|
mkdir -p out && cp "$B/appimage/storebound_${V}_amd64.AppImage" "$B/deb/storebound_${V}_amd64.deb" out/
|
|
chmod +x out/*.AppImage
|
|
(cd /tmp && rm -rf squashfs-root && "$GITHUB_WORKSPACE/out/storebound_${V}_amd64.AppImage" --appimage-extract >/dev/null && squashfs-root/usr/bin/storebound-desktop --self-test)
|
|
rm -rf /tmp/deb && dpkg-deb -x "out/storebound_${V}_amd64.deb" /tmp/deb && /tmp/deb/usr/bin/storebound-desktop --self-test
|
|
dpkg-deb -I "out/storebound_${V}_amd64.deb" | sed -n '1,20p'
|
|
- name: Start the app under Xvfb (AppImage and deb)
|
|
# --self-test checks only the sidecar; this opens the real window (GTK, WebKitGTK, the bundled libraries of the
|
|
# AppImage) on a virtual display. "sidecar started" in host.log means the webview ran the UI and called the host.
|
|
run: |
|
|
sudo apt-get install -y -qq --no-install-recommends xvfb xauth dbus-x11 >/dev/null
|
|
V=$(bun tools/desktop-version.ts --print)
|
|
smoke() { # <label> <executable>
|
|
local d; d=$(mktemp -d); local log="$d/data/dev.storebound.desktop/logs/host.log"
|
|
XDG_DATA_HOME="$d/data" XDG_CONFIG_HOME="$d/config" XDG_CACHE_HOME="$d/cache" \
|
|
xvfb-run -a dbus-run-session -- "$2" >"$d/out.txt" 2>&1 &
|
|
local pid=$! ok=0
|
|
for i in $(seq 1 90); do
|
|
if grep -q 'sidecar started' "$log" 2>/dev/null; then ok=1; break; fi
|
|
kill -0 "$pid" 2>/dev/null || break
|
|
sleep 1
|
|
done
|
|
sleep 3; kill -0 "$pid" 2>/dev/null || ok=0
|
|
pkill -TERM -f storebound-desktop || true; wait "$pid" 2>/dev/null || true
|
|
echo "--- $1 host.log"; cat "$log" 2>/dev/null || true
|
|
local wv="$d/data/dev.storebound.desktop/logs/webview.log"
|
|
if [ -f "$wv" ]; then echo "--- $1 webview.log"; cat "$wv"; grep -qE '^\S+ error ' "$wv" && ok=0; fi
|
|
grep -qE '^\S+ error |panicked' "$log" 2>/dev/null && ok=0
|
|
if [ "$ok" != 1 ]; then echo "--- $1 output"; tail -n 60 "$d/out.txt"; echo "$1: the window did not start the UI" >&2; return 1; fi
|
|
echo "$1: window started, UI reached the sidecar"
|
|
}
|
|
smoke AppImage "$GITHUB_WORKSPACE/out/storebound_${V}_amd64.AppImage"
|
|
smoke deb /tmp/deb/usr/bin/storebound-desktop
|
|
- name: Privacy scan
|
|
run: bun tools/privacy-scan.ts out/
|
|
- uses: actions/upload-artifact@v3
|
|
with:
|
|
name: storebound-desktop-linux
|
|
path: out/
|
|
retention-days: 7
|
|
|
|
windows:
|
|
needs: gate
|
|
if: github.event_name != 'pull_request'
|
|
# the Windows runner on the VDS ("windows" label, host mode): Rust (MSVC), Bun, 7-Zip, pwsh
|
|
runs-on: windows
|
|
timeout-minutes: 90
|
|
env:
|
|
CARGO_TARGET_DIR: C:\storebound-target
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '20'
|
|
- name: Install and check
|
|
shell: pwsh
|
|
run: |
|
|
bun install --frozen-lockfile
|
|
bun tools/desktop-version.ts
|
|
bun tools/build-sidecars.ts --target bun-windows-x64
|
|
- name: Node bundle on Windows (npx storebound) - stdin prompts read with node, clean exit
|
|
shell: pwsh
|
|
run: |
|
|
bun tools/build-node.ts
|
|
node --version
|
|
bun tools/node-smoke.ts --only prompt
|
|
if ($LASTEXITCODE -ne 0) { throw "node prompt smoke failed" }
|
|
"n" | node dist/storebound.mjs --version
|
|
if ($LASTEXITCODE -ne 0) { throw "node dist/storebound.mjs --version failed" }
|
|
- name: Build NSIS installer (per user, WebView2 bootstrapper, path-free)
|
|
shell: pwsh
|
|
working-directory: apps/desktop
|
|
run: |
|
|
Remove-Item -Recurse -Force "$env:CARGO_TARGET_DIR\release\bundle\nsis" -ErrorAction SilentlyContinue
|
|
bun ../../tools/desktop-release.ts exec -- bunx tauri build --bundles nsis --ci
|
|
- name: Install per user, self-test, uninstall
|
|
shell: pwsh
|
|
run: |
|
|
$V = bun tools/desktop-version.ts --print
|
|
New-Item -ItemType Directory -Force out | Out-Null
|
|
Copy-Item "$env:CARGO_TARGET_DIR\release\bundle\nsis\storebound_${V}_x64-setup.exe" out\
|
|
Start-Process -Wait -FilePath "out\storebound_${V}_x64-setup.exe" -ArgumentList '/S'
|
|
$exe = "$env:LOCALAPPDATA\storebound\storebound-desktop.exe"
|
|
if (-not (Test-Path $exe)) { throw "not installed per user at $exe" }
|
|
& $exe --self-test | Tee-Object -Variable st
|
|
if ($LASTEXITCODE -ne 0) { throw "self-test failed" }
|
|
Start-Process -Wait -FilePath "$env:LOCALAPPDATA\storebound\uninstall.exe" -ArgumentList '/S'
|
|
- name: Privacy scan (no .pdb, no paths)
|
|
shell: pwsh
|
|
run: bun tools/privacy-scan.ts out
|
|
- uses: actions/upload-artifact@v3
|
|
with:
|
|
name: storebound-desktop-windows
|
|
path: out/
|
|
retention-days: 7
|
|
|
|
record:
|
|
needs: [gate, ci, acceptance, linux, windows]
|
|
if: ${{ always() && github.event_name != 'pull_request' && needs.gate.result == 'success' && needs.linux.result == 'success' && needs.windows.result == 'success' && ((needs.gate.outputs.reuse == 'true' && needs.ci.result == 'skipped' && needs.acceptance.result == 'skipped') || (needs.ci.result == 'success' && needs.acceptance.result == 'success')) }}
|
|
runs-on: ubuntu-22.04
|
|
timeout-minutes: 30
|
|
env:
|
|
FORGEJO_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
|
FORGEJO_URL: ${{ github.server_url }}
|
|
# uploads over 100 MB go to the origin directly (Cloudflare refuses them): tools/forgejo-release.ts
|
|
FORGEJO_ORIGIN: ${{ secrets.FORGEJO_ORIGIN }}
|
|
SHA: ${{ github.sha }}
|
|
REUSE: ${{ needs.gate.outputs.reuse }}
|
|
FROM: ${{ needs.gate.outputs.from }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Tools
|
|
run: |
|
|
sudo apt-get update -qq
|
|
sudo apt-get install -y -qq --no-install-recommends squashfs-tools p7zip-full xz-utils binutils unzip file >/dev/null
|
|
curl -fsSL https://bun.sh/install | bash -s "bun-v${BUN_VERSION}" >/dev/null
|
|
echo "$HOME/.bun/bin" >> "${FORGEJO_PATH:-$GITHUB_PATH}"
|
|
[ -n "$FORGEJO_TOKEN" ] || { echo "secret RELEASE_TOKEN is missing (repo Settings > Actions > Secrets)" >&2; exit 1; }
|
|
- uses: actions/download-artifact@v3
|
|
with:
|
|
name: storebound-desktop-linux
|
|
path: cand
|
|
- uses: actions/download-artifact@v3
|
|
with:
|
|
name: storebound-desktop-windows
|
|
path: cand
|
|
- uses: actions/download-artifact@v3
|
|
if: ${{ needs.gate.outputs.reuse != 'true' }}
|
|
with:
|
|
path: runs
|
|
- name: Acceptance runs (this run's, or the version-only parent's)
|
|
run: |
|
|
mkdir -p cand/acceptance
|
|
if [ "$REUSE" = true ]; then
|
|
bun tools/release-candidate.ts fetch --sha "$FROM" --dir cand/acceptance --only '^acceptance-.*\.json$'
|
|
else
|
|
find runs -path '*acceptance-*' -name '*.json' -exec cp {} cand/acceptance/ \;
|
|
fi
|
|
ls cand/acceptance
|
|
V=$(bun tools/desktop-version.ts --print)
|
|
bun tools/acceptance.ts report cand/acceptance --md "cand/storebound_${V}_acceptance.md" --expect 6 --strict
|
|
- name: Privacy scan (private terms) of the installers
|
|
env:
|
|
FORBIDDEN_TERMS: ${{ secrets.FORBIDDEN_TERMS }}
|
|
run: |
|
|
[ -n "$FORBIDDEN_TERMS" ] || { echo "secret FORBIDDEN_TERMS is missing" >&2; exit 1; }
|
|
umask 077; printf '%s\n' "$FORBIDDEN_TERMS" > "$RUNNER_TEMP/terms.txt"
|
|
rm -f cand/SHA256SUMS
|
|
STOREBOUND_FORBIDDEN_TERMS="$RUNNER_TEMP/terms.txt" bun tools/privacy-scan.ts cand/*.AppImage cand/*.deb cand/*.exe
|
|
rm -f "$RUNNER_TEMP/terms.txt"
|
|
- name: Record the candidate (draft rc-<sha>, green.json last)
|
|
run: |
|
|
bun tools/release-candidate.ts record --sha "$SHA" --run "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_NUMBER" --dir cand ${FROM:+--reused-from "$FROM"} --yes
|
|
bun tools/release-candidate.ts prune --keep 12 --yes
|