From 07d7fbfa0799066ced25f911669621e24d0df550 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Tue, 6 Oct 2026 07:19:20 -0400 Subject: [PATCH] Windows on ARM64: release builds, and CI that installs and runs them on ARM64 (#61) - package.ps1 takes -Arch arm64 (aarch64-pc-windows-msvc, WiX -arch arm64) and now checks each binary's PE Machine as well as its Subsystem, so an x64 build can never ship labelled arm64. - release.yml builds, signs and packages a Windows ARM64 MSI and portable zip next to x64 and x86, cross-compiled on the x64 runner so signing and WiX run exactly as they do for x64. - New windows-arm64.yml (PRs touching Cargo/packaging, main, weekly): packages the ARM64 MSI the same way (unsigned), installs it on a Windows 11 ARM64 runner, checks both installed binaries are ARM64, opens/reads/edits/ renders/saves a PDF with the installed CLI, uninstalls; and runs the whole test suite natively on ARM64. The MSI is kept as an artifact for 7 days. - README: Windows builds for x64, x86 and ARM64. Requested by @maxffarrell. Co-Authored-By: Claude Opus 5.5 --- .github/workflows/release.yml | 3 + .github/workflows/windows-arm64.yml | 126 ++++++++++++++++++++++++++++ README.md | 2 +- packaging/windows/package.ps1 | 23 +++-- 4 files changed, 144 insertions(+), 10 deletions(-) create mode 100644 .github/workflows/windows-arm64.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 349088ce..59bda065 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -112,6 +112,9 @@ jobs: include: - { arch: x64, target: x86_64-pc-windows-msvc } - { arch: x86, target: i686-pc-windows-msvc } + # Windows on ARM (#61): cross-compiled on the x64 runner, so signing and WiX run as above. + # .github/workflows/windows-arm64.yml installs and runs it on ARM64 hardware. + - { arch: arm64, target: aarch64-pc-windows-msvc } env: PRINTCRAFT_VERSION: ${{ needs.version.outputs.version }} PRINTCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }} diff --git a/.github/workflows/windows-arm64.yml b/.github/workflows/windows-arm64.yml new file mode 100644 index 00000000..bb05a3eb --- /dev/null +++ b/.github/workflows/windows-arm64.yml @@ -0,0 +1,126 @@ +# Windows on ARM (#61): package the ARM64 release the way release.yml does (cross-compiled on an +# x64 runner, unsigned here), then install that MSI on a Windows 11 ARM64 runner and run it, and +# run the test suite natively on ARM64. +name: Windows ARM64 + +on: + push: + branches: [main] + pull_request: + paths: + - Cargo.toml + - Cargo.lock + - "**/Cargo.toml" + - "**/build.rs" + - .github/workflows/windows-arm64.yml + - packaging/windows/** + schedule: + - cron: "41 4 * * 1" # weekly, so drift in the runner images shows up + workflow_dispatch: + +concurrency: + group: windows-arm64-${{ github.ref }} + cancel-in-progress: true + +permissions: + contents: read + +env: + CARGO_TERM_COLOR: always + CARGO_INCREMENTAL: 0 + RUST_BACKTRACE: 1 + +jobs: + package: + name: package (cross-compiled on x64) + runs-on: windows-latest + timeout-minutes: 90 + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + targets: aarch64-pc-windows-msvc + - uses: Swatinem/rust-cache@v2 + with: + key: windows-arm64-package + - name: Install WiX + shell: pwsh + run: dotnet tool install --global wix --version 5.0.2 + - name: Build and package (unsigned) + shell: pwsh + env: + DIST: ${{ github.workspace }}\dist\arm64 + run: ./packaging/windows/package.ps1 -Arch arm64 + - uses: actions/upload-artifact@v4 + with: + name: printcraft-windows-arm64 + path: dist/arm64/* + if-no-files-found: error + retention-days: 7 + + install: + name: install and run on ARM64 + needs: package + runs-on: windows-11-arm + timeout-minutes: 30 + steps: + - uses: actions/download-artifact@v4 + with: + name: printcraft-windows-arm64 + path: dist + - name: Install the MSI, check it, run it, uninstall it + shell: pwsh + run: | + $ErrorActionPreference = 'Stop' + $msi = (Get-ChildItem dist/*.msi | Select-Object -First 1).FullName + $p = Start-Process msiexec.exe -ArgumentList '/i', "`"$msi`"", '/qn', '/l*v', 'install.log' -Wait -PassThru + if ($p.ExitCode -ne 0) { Get-Content install.log -Tail 60; throw "msiexec /i exited $($p.ExitCode)" } + $dir = Join-Path $env:ProgramFiles 'PrintCraft' + foreach ($exe in 'printcraft.exe', 'printcraft-cli.exe') { + $path = Join-Path $dir $exe + if (-not (Test-Path $path)) { Get-ChildItem -Recurse $env:ProgramFiles -Filter $exe | Select-Object -First 3; throw "$exe not installed in $dir" } + $bytes = [System.IO.File]::ReadAllBytes($path) + $machine = [BitConverter]::ToUInt16($bytes, [BitConverter]::ToInt32($bytes, 0x3C) + 4) + if ($machine -ne 0xAA64) { throw "$exe is for machine 0x$('{0:X}' -f $machine), not ARM64" } + Write-Output "ok $path (ARM64)" + } + # The installed CLI runs natively: open, render and edit a small PDF through the engine. + $cli = Join-Path $dir 'printcraft-cli.exe' + & $cli tools | Out-Null + if ($LASTEXITCODE -ne 0) { throw "printcraft-cli tools exited $LASTEXITCODE" } + $body = 'BT /F1 24 Tf 20 150 Td (Hello ARM64) Tj ET' + $objs = @('<< /Type /Catalog /Pages 2 0 R >>', '<< /Type /Pages /Kids [3 0 R] /Count 1 >>', + '<< /Type /Page /Parent 2 0 R /MediaBox [0 0 300 200] /Contents 4 0 R /Resources << /Font << /F1 5 0 R >> >> >>', + "<< /Length $($body.Length) >>`nstream`n$body`nendstream", '<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica >>') + $sb = [System.Text.StringBuilder]::new("%PDF-1.7`n"); $offsets = @() + for ($i = 0; $i -lt $objs.Count; $i++) { $offsets += $sb.Length; [void]$sb.Append("$($i + 1) 0 obj`n$($objs[$i])`nendobj`n") } + $xref = $sb.Length + [void]$sb.Append("xref`n0 $($objs.Count + 1)`n0000000000 65535 f `n") + foreach ($o in $offsets) { [void]$sb.Append(('{0:D10} 00000 n `n' -f $o)) } + [void]$sb.Append("trailer`n<< /Size $($objs.Count + 1) /Root 1 0 R >>`nstartxref`n$xref`n%%EOF`n") + New-Item -ItemType Directory -Force smoke | Out-Null + [System.IO.File]::WriteAllText("$PWD\smoke\hello.pdf", $sb.ToString(), [System.Text.Encoding]::ASCII) + $steps = '[{"tool":"doc_open","args":{"path":"hello.pdf"}},{"tool":"text_paragraphs","args":{"doc":1,"page":1}},{"tool":"text_edit","args":{"doc":1,"page":1,"paragraph":1,"text":"Edited on ARM64"}},{"tool":"page_render","args":{"doc":1,"page":1,"dpi":72},"out":"smoke/page.png"},{"tool":"doc_save","args":{"doc":1,"path":"out.pdf"}}]' + [System.IO.File]::WriteAllText("$PWD\smoke\steps.json", $steps) + $out = & $cli run --script smoke\steps.json --root smoke 2>&1 | Out-String + if ($LASTEXITCODE -ne 0) { Write-Output $out; throw "printcraft-cli run exited $LASTEXITCODE" } + if ($out -notmatch 'Hello ARM64') { Write-Output $out; throw 'text_paragraphs did not read the page' } + foreach ($f in 'smoke\page.png', 'smoke\out.pdf') { if (-not (Test-Path $f) -or (Get-Item $f).Length -eq 0) { Write-Output $out; throw "$f was not written" } } + Write-Output 'ok printcraft-cli: opened, read, edited, rendered and saved a PDF on ARM64' + $p = Start-Process msiexec.exe -ArgumentList '/x', "`"$msi`"", '/qn' -Wait -PassThru + if ($p.ExitCode -ne 0) { throw "msiexec /x exited $($p.ExitCode)" } + if (Test-Path (Join-Path $dir 'printcraft.exe')) { throw 'uninstall left printcraft.exe behind' } + Write-Output 'ok uninstalled' + + test: + name: test (native ARM64) + runs-on: windows-11-arm + timeout-minutes: 120 + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 + with: + key: windows-arm64-test + - name: Test + run: cargo test --workspace --locked diff --git a/README.md b/README.md index 86d9ef59..9a664095 100644 --- a/README.md +++ b/README.md @@ -256,7 +256,7 @@ Press ⌘K to search every tool and command, or browse the **All tool ## Runs everywhere, stays yours -- **Native on macOS, Windows, Linux and FreeBSD**, and **in the browser** through WebAssembly, from the same Rust codebase. +- **Native on macOS, Windows, Linux and FreeBSD**, and **in the browser** through WebAssembly, from the same Rust codebase. Windows builds come for x64, x86 and ARM64 (Windows on ARM, no emulation); every ARM64 change is tested on ARM64 hardware in CI. - **Private by design.** Documents never leave your machine. There's no account, no telemetry and no cloud processing. - **Engine first.** Parsing, rendering and editing live in reusable library crates. The interface is one swappable layer on top. - **Scriptable.** The `printcraft-cli` tool (see [Built for agents, too](#built-for-agents-too)) covers inspecting, rendering, extracting text, editing, combining, extracting pages and splitting. Robustness sweeps run on the same engine as the app. diff --git a/packaging/windows/package.ps1 b/packaging/windows/package.ps1 index 71b23c72..014363f6 100644 --- a/packaging/windows/package.ps1 +++ b/packaging/windows/package.ps1 @@ -17,9 +17,10 @@ .EXAMPLE pwsh packaging/windows/package.ps1 -Arch x64 pwsh packaging/windows/package.ps1 -Arch x86 -SkipBuild + pwsh packaging/windows/package.ps1 -Arch arm64 # cross-compiled; needs the MSVC ARM64 build tools #> param( - [ValidateSet('x64', 'x86')] [string] $Arch = 'x64', + [ValidateSet('x64', 'x86', 'arm64')] [string] $Arch = 'x64', [switch] $SkipBuild ) $ErrorActionPreference = 'Stop' @@ -44,7 +45,7 @@ if (-not $Version) { throw 'could not read [workspace.package] version from Carg # MSI ProductVersion is numeric (major.minor.build); pre-release tags are dropped there. $MsiVersion = ($Version -split '-')[0] -$Target = if ($Arch -eq 'x64') { 'x86_64-pc-windows-msvc' } else { 'i686-pc-windows-msvc' } +$Target = switch ($Arch) { 'x64' { 'x86_64-pc-windows-msvc' } 'x86' { 'i686-pc-windows-msvc' } 'arm64' { 'aarch64-pc-windows-msvc' } } $Dist = if ($env:DIST) { $env:DIST } else { Join-Path $Root 'dist\release' } $TargetDir = if ($env:CARGO_TARGET_DIR) { $env:CARGO_TARGET_DIR } else { Join-Path $Root 'target' } New-Item -ItemType Directory -Force -Path $Dist | Out-Null @@ -66,17 +67,21 @@ if (-not $SkipBuild) { $Bin = Join-Path $TargetDir "$Target\release" -# The PE optional header's Subsystem field: 2 = Windows GUI, 3 = console. The app must be GUI (no -# console window opens with it, #57); the CLI must stay console so its output reaches the terminal. -function Get-PeSubsystem([string] $Path) { +# Check both binaries' PE headers before packaging. Machine (COFF header) must match -Arch, so an +# x64 build can never ship labelled arm64 (#61). Subsystem (optional header): 2 = Windows GUI, +# 3 = console. The app must be GUI (no console window opens with it, #57); the CLI must stay +# console so its output reaches the terminal. +function Get-PeHeader([string] $Path) { $bytes = [System.IO.File]::ReadAllBytes($Path) $pe = [BitConverter]::ToInt32($bytes, 0x3C) - return [BitConverter]::ToUInt16($bytes, $pe + 0x5C) + return @{ Machine = [BitConverter]::ToUInt16($bytes, $pe + 4); Subsystem = [BitConverter]::ToUInt16($bytes, $pe + 0x5C) } } +$Machine = switch ($Arch) { 'x64' { 0x8664 } 'x86' { 0x14C } 'arm64' { 0xAA64 } } foreach ($check in @(@('printcraft.exe', 2), @('printcraft-cli.exe', 3))) { - $subsystem = Get-PeSubsystem (Join-Path $Bin $check[0]) - if ($subsystem -ne $check[1]) { throw "$($check[0]) has PE subsystem $subsystem, expected $($check[1])" } - Write-Output "ok $($check[0]): PE subsystem $subsystem" + $h = Get-PeHeader (Join-Path $Bin $check[0]) + if ($h.Machine -ne $Machine) { throw "$($check[0]) is for machine 0x$('{0:X}' -f $h.Machine), expected 0x$('{0:X}' -f $Machine) ($Arch)" } + if ($h.Subsystem -ne $check[1]) { throw "$($check[0]) has PE subsystem $($h.Subsystem), expected $($check[1])" } + Write-Output "ok $($check[0]): $Arch, PE subsystem $($h.Subsystem)" } $Stage = Join-Path $TargetDir "windows-package\$Arch" Remove-Item -Recurse -Force $Stage -ErrorAction SilentlyContinue