Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,12 @@ jobs:
if [[ "$RUNNER_OS" == Windows ]]; then binary="$binary.exe"; fi
if [[ "$RUNNER_OS" == macOS ]]; then codesign --force --sign - "$binary"; fi
cargo xtask bundle "$binary" dist "$ASSET"
- name: Ensure Inno Setup is available
- name: Install the Velopack packaging tool
if: runner.os == 'Windows'
shell: bash
run: choco install innosetup --yes --no-progress
run: |
dotnet tool install --global vpk --version 1.2.161
echo "$USERPROFILE/.dotnet/tools" >> "$GITHUB_PATH"
- name: Build native installer
shell: bash
env:
Expand Down
15 changes: 13 additions & 2 deletions .github/workflows/winget.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,19 @@ jobs:
& $winget --version
if ($LASTEXITCODE -ne 0) { throw 'WinGet could not start' }
$failed = $false
$versions = Get-ChildItem packaging/winget -Recurse -Filter '*.installer.yaml'
if (-not $versions) { throw 'No WinGet manifests found' }
$versions = @()
if (Test-Path packaging/winget) {
$versions = Get-ChildItem packaging/winget -Recurse -Filter '*.installer.yaml'
}
if (-not $versions) {
# A version or locale manifest without its installer manifest is an
# incomplete submission, not an empty folder.
if ((Test-Path packaging/winget) -and (Get-ChildItem packaging/winget -Recurse -Filter '*.yaml')) {
throw 'WinGet manifests are present without an installer manifest'
}
'No WinGet manifests to validate.' >> $env:GITHUB_STEP_SUMMARY
exit 0
Comment thread
sudo-py-dev marked this conversation as resolved.
Resolved
}
foreach ($installer in $versions) {
$directory = $installer.Directory.FullName
$log = Join-Path $env:RUNNER_TEMP ($installer.BaseName + '.validation.txt')
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,9 @@ Set the package version in `Cargo.toml`, refresh `Cargo.lock`, commit, and push

Windows builds statically link the Microsoft C++ runtime and verify the executable imports before packaging, so clean Windows installations do not need the Visual C++ Redistributable.

The workflow publishes a stable GitHub release with generated release notes after all four builds pass, making the downloads and in-app update available immediately. Rerunning it for the same tag replaces the release assets and publishes any existing draft. Prereleases and drafts are ignored by the updater. Release asset names form the updater contract and must stay consistent with `src/updater.rs`. Forks should change the repository constant there. Every release also includes a compressed Inno Setup installer, an xz-compressed Debian package, and architecture-specific macOS `.pkg` installers. Installer assets receive SHA-256 sidecars too. The macOS packages are unsigned until Developer ID signing and notarization credentials are configured; the workflow currently uses ad-hoc app signing. If the `VERCEL_DEPLOY_HOOK` secret is set, the workflow also asks Vercel to rebuild the website.
The workflow publishes a stable GitHub release with generated release notes after all four builds pass, making the downloads and in-app update available immediately. Rerunning it for the same tag replaces the release assets and publishes any existing draft. Prereleases and drafts are ignored by the updater. Release asset names form the updater contract and must stay consistent with `src/updater.rs`. Forks should change the repository constant there. Every release also includes a Velopack Windows setup with its full update package (`reclaim-windows-x86_64-full.nupkg`), an xz-compressed Debian package, and architecture-specific macOS `.pkg` installers. Installer assets receive SHA-256 sidecars too. The macOS packages are unsigned until Developer ID signing and notarization credentials are configured; the workflow currently uses ad-hoc app signing. If the `VERCEL_DEPLOY_HOOK` secret is set, the workflow also asks Vercel to rebuild the website.

To build a native installer locally after compiling the release executable, run `cargo xtask package linux --binary target/release/reclaim` (or use `windows` / `macos` with the matching executable and `--arch aarch64` for Apple Silicon). The Rust tool requires `dpkg-deb` on Linux, Inno Setup 6 on Windows, or Apple command-line tools on macOS. Output goes to `dist/`.
To build a native installer locally after compiling the release executable, run `cargo xtask package linux --binary target/release/reclaim` (or use `windows` / `macos` with the matching executable and `--arch aarch64` for Apple Silicon). The Rust tool requires `dpkg-deb` on Linux, the Velopack `vpk` tool on Windows (`dotnet tool install --global vpk --version 1.2.161`), or Apple command-line tools on macOS. Output goes to `dist/`.

</details>

Expand Down
30 changes: 16 additions & 14 deletions docs/DISTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,27 @@

## WinGet

The initial package is `sudo-py-dev.Reclaim` version `0.2.3`, submitted for review at
https://github.com/microsoft/winget-pkgs/pull/478554. Publication depends on Microsoft's review and checks; opening the PR does not make the package available immediately.

The submission files are in `packaging/winget/manifests/s/sudo-py-dev/Reclaim/0.2.3/`.
The installer is the existing upstream per-user x64 Inno Setup release. Its SHA-256
was independently downloaded and verified, and the manifests pass Microsoft's
1.28.0 JSON schemas. Windows installation testing must be completed by WinGet CI
or on a Windows machine. The account owner must personally handle any required
Contributor License Agreement acceptance.

Once accepted:
The package id is `sudo-py-dev.Reclaim`. Version 0.2.3 was submitted for review at
https://github.com/microsoft/winget-pkgs/pull/478554; its manifests were removed
from this repository with the move to Velopack, and the copy in that PR is the
record. Publication depends on Microsoft's review and checks.

```powershell
winget install --id sudo-py-dev.Reclaim --exact
```

For subsequent releases, create a new version directory, update every version and
the version-specific download URL, hash the actual installer, and submit an update
PR to `microsoft/winget-pkgs`. Do not point installer URLs at `latest`.
For each new release, add `packaging/winget/manifests/s/sudo-py-dev/Reclaim/<version>/`
with the three manifest files, point the installer URL at that version's
`reclaim-windows-x86_64-setup.exe` (never at `latest`), hash the actual file, and
submit an update PR to `microsoft/winget-pkgs`. The WinGet workflow validates any
manifests in that folder. The account owner must personally handle any required
Contributor License Agreement acceptance.

The Velopack setup needs `InstallerType: exe`, `Scope: user`, `InstallerSwitches`
with `Silent: --silent` and `SilentWithProgress: --silent`, and
`ProductCode: sudo-py-dev.Reclaim` (the Velopack package id, which is also its
uninstall entry). It installs to `%LocalAppData%\sudo-py-dev.Reclaim`. Check the
uninstall entry name on a real install before the first submission.

## Standalone Flatpak

Expand Down
11 changes: 9 additions & 2 deletions docs/security-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,15 @@ this policy does not require the operating system to run in one process.

The updater uses HTTPS through Rust libraries and SHA-256 verification. Unix
executable replacement uses Rust filesystem operations. On Windows, Rust code
starts the verified Inno Setup package directly through the Win32 process API;
the app never launches cmd.exe, PowerShell, or a cleanup executable. Native OS
downloads the Velopack full package (`.nupkg`), checks its Minisign signature
and SHA-256, then starts the installed Velopack `Update.exe apply` directly
through the Win32 process API with the verified file. Velopack's own release
feed is not used, so the release key stays the only trust root. The app never
launches cmd.exe or PowerShell. Velopack hook commands (`--veloapp-*`) exit
before any window opens. The install and update hooks remove a copy left
by the old installer (0.2.4 and earlier): `src/legacy_install.rs` reads its
folder from the per-user uninstall entry, falls back to the default folder,
and starts `unins000.exe` silently only when the old marker file is next to it. Native OS
APIs open browser links and installer files without command helpers.

On Linux a native D-Bus session address is required. Process-backed transports,
Expand Down
1 change: 0 additions & 1 deletion locales/ar.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "واجه Reclaim خطأً غير متوقع ويجب إغلاقه.",
"Reclaim stopped because of a Windows exception.": "توقف Reclaim بسبب استثناء في Windows.",
"Run the Windows setup once to enable automatic updates": "شغّل برنامج إعداد Windows مرة واحدة لتفعيل التحديثات التلقائية",
"Starting installer…": "جارٍ تشغيل برنامج التثبيت…",
"The desktop did not open the link or file. Try opening it manually.": "لم يفتح سطح المكتب الرابط أو الملف. جرّب فتحه يدويًا.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "أعاد سطح المكتب طلب فتح غير متوقع. جرّب فتح الرابط أو الملف يدويًا.",
"The diagnostic log could not be written.": "تعذرت كتابة سجل التشخيص.",
Expand Down
1 change: 0 additions & 1 deletion locales/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "In Reclaim ist ein unerwarteter Fehler aufgetreten. Die App muss beendet werden.",
"Reclaim stopped because of a Windows exception.": "Reclaim wurde wegen einer Windows-Ausnahme beendet.",
"Run the Windows setup once to enable automatic updates": "Führen Sie einmal das Windows-Setup aus, um automatische Updates zu aktivieren",
"Starting installer…": "Installationsprogramm wird gestartet…",
"The desktop did not open the link or file. Try opening it manually.": "Der Desktop hat den Link oder die Datei nicht geöffnet. Öffnen Sie sie manuell.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "Der Desktop hat eine unerwartete Öffnen-Anfrage zurückgegeben. Öffnen Sie den Link oder die Datei manuell.",
"The diagnostic log could not be written.": "Das Diagnoseprotokoll konnte nicht geschrieben werden.",
Expand Down
1 change: 0 additions & 1 deletion locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "Reclaim encountered an unexpected error and must close.",
"Reclaim stopped because of a Windows exception.": "Reclaim stopped because of a Windows exception.",
"Run the Windows setup once to enable automatic updates": "Run the Windows setup once to enable automatic updates",
"Starting installer…": "Starting installer…",
"The desktop did not open the link or file. Try opening it manually.": "The desktop did not open the link or file. Try opening it manually.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "The desktop returned an unexpected open request. Try opening the link or file manually.",
"The diagnostic log could not be written.": "The diagnostic log could not be written.",
Expand Down
1 change: 0 additions & 1 deletion locales/es.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "Reclaim encontró un error inesperado y debe cerrarse.",
"Reclaim stopped because of a Windows exception.": "Reclaim se detuvo por una excepción de Windows.",
"Run the Windows setup once to enable automatic updates": "Ejecuta una vez el instalador de Windows para activar las actualizaciones automáticas",
"Starting installer…": "Iniciando el instalador…",
"The desktop did not open the link or file. Try opening it manually.": "El escritorio no abrió el enlace ni el archivo. Prueba a abrirlo manualmente.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "El escritorio devolvió una solicitud de apertura inesperada. Prueba a abrir el enlace o el archivo manualmente.",
"The diagnostic log could not be written.": "No se pudo escribir el registro de diagnóstico.",
Expand Down
1 change: 0 additions & 1 deletion locales/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "Reclaim a rencontré une erreur inattendue et doit se fermer.",
"Reclaim stopped because of a Windows exception.": "Reclaim s’est arrêté à cause d’une exception Windows.",
"Run the Windows setup once to enable automatic updates": "Lancez une fois le programme d’installation Windows pour activer les mises à jour automatiques",
"Starting installer…": "Lancement du programme d’installation…",
"The desktop did not open the link or file. Try opening it manually.": "Le bureau n’a pas ouvert le lien ou le fichier. Essayez de l’ouvrir manuellement.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "Le bureau a renvoyé une demande d’ouverture inattendue. Essayez d’ouvrir le lien ou le fichier manuellement.",
"The diagnostic log could not be written.": "Impossible d’écrire le journal de diagnostic.",
Expand Down
1 change: 0 additions & 1 deletion locales/he.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "אירעה ב־Reclaim שגיאה לא צפויה, והיא תיסגר.",
"Reclaim stopped because of a Windows exception.": "Reclaim נעצרה בגלל חריגה של Windows.",
"Run the Windows setup once to enable automatic updates": "הריצו פעם אחת את תוכנית ההתקנה של Windows כדי לאפשר עדכונים אוטומטיים",
"Starting installer…": "מפעילה את תוכנית ההתקנה…",
"The desktop did not open the link or file. Try opening it manually.": "שולחן העבודה לא פתח את הקישור או הקובץ. נסו לפתוח אותו ידנית.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "שולחן העבודה החזיר בקשת פתיחה לא צפויה. נסו לפתוח את הקישור או הקובץ ידנית.",
"The diagnostic log could not be written.": "לא ניתן לכתוב את יומן האבחון.",
Expand Down
1 change: 0 additions & 1 deletion locales/ru.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,6 @@
"Reclaim encountered an unexpected error and must close.": "В Reclaim произошла непредвиденная ошибка, приложение будет закрыто.",
"Reclaim stopped because of a Windows exception.": "Reclaim остановлен из-за исключения Windows.",
"Run the Windows setup once to enable automatic updates": "Один раз запустите установщик Windows, чтобы включить автоматические обновления",
"Starting installer…": "Запуск установщика…",
"The desktop did not open the link or file. Try opening it manually.": "Рабочий стол не открыл ссылку или файл. Попробуйте открыть вручную.",
"The desktop returned an unexpected open request. Try opening the link or file manually.": "Рабочий стол вернул неожиданный запрос на открытие. Попробуйте открыть ссылку или файл вручную.",
"The diagnostic log could not be written.": "Не удалось записать журнал диагностики.",
Expand Down
1 change: 0 additions & 1 deletion packaging/windows/installed-by-inno

This file was deleted.

51 changes: 0 additions & 51 deletions packaging/windows/reclaim.iss

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading