bundle-windows.ps1

  1[CmdletBinding()]
  2Param(
  3    [Parameter()][Alias('i')][switch]$Install,
  4    [Parameter()][Alias('h')][switch]$Help,
  5    [Parameter()][string]$Name
  6)
  7
  8. "$PSScriptRoot/lib/blob-store.ps1"
  9. "$PSScriptRoot/lib/workspace.ps1"
 10
 11# https://stackoverflow.com/questions/57949031/powershell-script-stops-if-program-fails-like-bash-set-o-errexit
 12$ErrorActionPreference = 'Stop'
 13$PSNativeCommandUseErrorActionPreference = $true
 14
 15$buildSuccess = $false
 16
 17if ($Help) {
 18    Write-Output "Usage: test.ps1 [-Install] [-Help]"
 19    Write-Output "Build the installer for Windows.\n"
 20    Write-Output "Options:"
 21    Write-Output "  -Install, -i  Run the installer after building."
 22    Write-Output "  -Help, -h     Show this help message."
 23    exit 0
 24}
 25
 26Push-Location -Path crates/zed
 27$channel = Get-Content "RELEASE_CHANNEL"
 28$env:ZED_RELEASE_CHANNEL = $channel
 29$env:RELEASE_CHANNEL = $channel
 30Pop-Location
 31
 32function CheckEnvironmentVariables {
 33    $requiredVars = @(
 34        'ZED_WORKSPACE', 'RELEASE_VERSION', 'ZED_RELEASE_CHANNEL',
 35        'AZURE_TENANT_ID', 'AZURE_CLIENT_ID', 'AZURE_CLIENT_SECRET',
 36        'ACCOUNT_NAME', 'CERT_PROFILE_NAME', 'ENDPOINT',
 37        'FILE_DIGEST', 'TIMESTAMP_DIGEST', 'TIMESTAMP_SERVER'
 38    )
 39
 40    foreach ($var in $requiredVars) {
 41        if (-not (Test-Path "env:$var")) {
 42            Write-Error "$var is not set"
 43            exit 1
 44        }
 45    }
 46}
 47
 48function PrepareForBundle {
 49    if (Test-Path "$innoDir") {
 50        Remove-Item -Path "$innoDir" -Recurse -Force
 51    }
 52    New-Item -Path "$innoDir" -ItemType Directory -Force
 53    Copy-Item -Path "$env:ZED_WORKSPACE\crates\zed\resources\windows\*" -Destination "$innoDir" -Recurse -Force
 54    New-Item -Path "$innoDir\make_appx" -ItemType Directory -Force
 55    New-Item -Path "$innoDir\appx" -ItemType Directory -Force
 56    New-Item -Path "$innoDir\bin" -ItemType Directory -Force
 57    New-Item -Path "$innoDir\tools" -ItemType Directory -Force
 58}
 59
 60function GenerateLicenses {
 61    $oldErrorActionPreference = $ErrorActionPreference
 62    $ErrorActionPreference = 'Continue'
 63    . $PSScriptRoot/generate-licenses.ps1
 64    $ErrorActionPreference = $oldErrorActionPreference
 65}
 66
 67function BuildZedAndItsFriends {
 68    Write-Output "Building Zed and its friends, for channel: $channel"
 69    # Build zed.exe, cli.exe and auto_update_helper.exe
 70    cargo build --release --package zed --package cli --package auto_update_helper
 71    Copy-Item -Path ".\target\release\zed.exe" -Destination "$innoDir\Zed.exe" -Force
 72    Copy-Item -Path ".\target\release\cli.exe" -Destination "$innoDir\cli.exe" -Force
 73    Copy-Item -Path ".\target\release\auto_update_helper.exe" -Destination "$innoDir\auto_update_helper.exe" -Force
 74    # Build explorer_command_injector.dll
 75    switch ($channel) {
 76        "stable" {
 77            cargo build --release --features stable --no-default-features --package explorer_command_injector
 78        }
 79        "preview" {
 80            cargo build --release --features preview --no-default-features --package explorer_command_injector
 81        }
 82        default {
 83            cargo build --release --package explorer_command_injector
 84        }
 85    }
 86    Copy-Item -Path ".\target\release\explorer_command_injector.dll" -Destination "$innoDir\zed_explorer_command_injector.dll" -Force
 87}
 88
 89function ZipZedAndItsFriendsDebug {
 90    $items = @(
 91        ".\target\release\zed.pdb",
 92        ".\target\release\cli.pdb",
 93        ".\target\release\auto_update_helper.pdb",
 94        ".\target\release\explorer_command_injector.pdb"
 95    )
 96
 97    Compress-Archive -Path $items -DestinationPath ".\target\release\zed-$env:RELEASE_VERSION-$env:ZED_RELEASE_CHANNEL.dbg.zip" -Force
 98}
 99
100
101function UploadToSentry {
102    if (-not (Get-Command "sentry-cli" -ErrorAction SilentlyContinue)) {
103        Write-Output "sentry-cli not found. skipping sentry upload."
104        Write-Output "install with: 'winget install -e --id=Sentry.sentry-cli'"
105        return
106    }
107    if (-not (Test-Path "env:SENTRY_AUTH_TOKEN")) {
108        Write-Output "missing SENTRY_AUTH_TOKEN. skipping sentry upload."
109        return
110    }
111    Write-Output "Uploading zed debug symbols to sentry..."
112    sentry-cli debug-files upload --include-sources --wait -p zed -o zed-dev .\target\release\
113}
114
115function MakeAppx {
116    switch ($channel) {
117        "stable" {
118            $manifestFile = "$env:ZED_WORKSPACE\crates\explorer_command_injector\AppxManifest.xml"
119        }
120        "preview" {
121            $manifestFile = "$env:ZED_WORKSPACE\crates\explorer_command_injector\AppxManifest-Preview.xml"
122        }
123        default {
124            $manifestFile = "$env:ZED_WORKSPACE\crates\explorer_command_injector\AppxManifest-Nightly.xml"
125        }
126    }
127    Copy-Item -Path "$manifestFile" -Destination "$innoDir\make_appx\AppxManifest.xml"
128    # Add makeAppx.exe to Path
129    $sdk = "C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64"
130    $env:Path += ';' + $sdk
131    makeAppx.exe pack /d "$innoDir\make_appx" /p "$innoDir\zed_explorer_command_injector.appx" /nv
132}
133
134function SignZedAndItsFriends {
135    $files = "$innoDir\Zed.exe,$innoDir\cli.exe,$innoDir\auto_update_helper.exe,$innoDir\zed_explorer_command_injector.dll,$innoDir\zed_explorer_command_injector.appx"
136    & "$innoDir\sign.ps1" $files
137}
138
139function DownloadAMDGpuServices {
140    # If you update the AGS SDK version, please also update the version in `crates/gpui/src/platform/windows/directx_renderer.rs`
141    $url = "https://codeload.github.com/GPUOpen-LibrariesAndSDKs/AGS_SDK/zip/refs/tags/v6.3.0"
142    $zipPath = ".\AGS_SDK_v6.3.0.zip"
143    # Download the AGS SDK zip file
144    Invoke-WebRequest -Uri $url -OutFile $zipPath
145    # Extract the AGS SDK zip file
146    Expand-Archive -Path $zipPath -DestinationPath "." -Force
147}
148
149function CollectFiles {
150    Move-Item -Path "$innoDir\zed_explorer_command_injector.appx" -Destination "$innoDir\appx\zed_explorer_command_injector.appx" -Force
151    Move-Item -Path "$innoDir\zed_explorer_command_injector.dll" -Destination "$innoDir\appx\zed_explorer_command_injector.dll" -Force
152    Move-Item -Path "$innoDir\cli.exe" -Destination "$innoDir\bin\zed.exe" -Force
153    Move-Item -Path "$innoDir\zed.sh" -Destination "$innoDir\bin\zed" -Force
154    Move-Item -Path "$innoDir\auto_update_helper.exe" -Destination "$innoDir\tools\auto_update_helper.exe" -Force
155    Move-Item -Path ".\AGS_SDK-6.3.0\ags_lib\lib\amd_ags_x64.dll" -Destination "$innoDir\amd_ags_x64.dll" -Force
156}
157
158function BuildInstaller {
159    $issFilePath = "$innoDir\zed.iss"
160    switch ($channel) {
161        "stable" {
162            $appId = "{{2DB0DA96-CA55-49BB-AF4F-64AF36A86712}"
163            $appIconName = "app-icon"
164            $appName = "Zed"
165            $appDisplayName = "Zed"
166            $appSetupName = "ZedEditorUserSetup-x64-$env:RELEASE_VERSION"
167            # The mutex name here should match the mutex name in crates\zed\src\zed\windows_only_instance.rs
168            $appMutex = "Zed-Stable-Instance-Mutex"
169            $appExeName = "Zed"
170            $regValueName = "Zed"
171            $appUserId = "ZedIndustries.Zed"
172            $appShellNameShort = "Z&ed"
173            $appAppxFullName = "ZedIndustries.Zed_1.0.0.0_neutral__japxn1gcva8rg"
174        }
175        "preview" {
176            $appId = "{{F70E4811-D0E2-4D88-AC99-D63752799F95}"
177            $appIconName = "app-icon-preview"
178            $appName = "Zed Preview"
179            $appDisplayName = "Zed Preview"
180            $appSetupName = "ZedEditorUserSetup-x64-$env:RELEASE_VERSION-preview"
181            # The mutex name here should match the mutex name in crates\zed\src\zed\windows_only_instance.rs
182            $appMutex = "Zed-Preview-Instance-Mutex"
183            $appExeName = "Zed"
184            $regValueName = "ZedPreview"
185            $appUserId = "ZedIndustries.Zed.Preview"
186            $appShellNameShort = "Z&ed Preview"
187            $appAppxFullName = "ZedIndustries.Zed.Preview_1.0.0.0_neutral__japxn1gcva8rg"
188        }
189        "nightly" {
190            $appId = "{{1BDB21D3-14E7-433C-843C-9C97382B2FE0}"
191            $appIconName = "app-icon-nightly"
192            $appName = "Zed Nightly"
193            $appDisplayName = "Zed Nightly"
194            $appSetupName = "ZedEditorUserSetup-x64-$env:RELEASE_VERSION-nightly"
195            # The mutex name here should match the mutex name in crates\zed\src\zed\windows_only_instance.rs
196            $appMutex = "Zed-Nightly-Instance-Mutex"
197            $appExeName = "Zed"
198            $regValueName = "ZedNightly"
199            $appUserId = "ZedIndustries.Zed.Nightly"
200            $appShellNameShort = "Z&ed Editor Nightly"
201            $appAppxFullName = "ZedIndustries.Zed.Nightly_1.0.0.0_neutral__japxn1gcva8rg"
202        }
203        "dev" {
204            $appId = "{{8357632E-24A4-4F32-BA97-E575B4D1FE5D}"
205            $appIconName = "app-icon-dev"
206            $appName = "Zed Dev"
207            $appDisplayName = "Zed Dev"
208            $appSetupName = "ZedEditorUserSetup-x64-$env:RELEASE_VERSION-dev"
209            # The mutex name here should match the mutex name in crates\zed\src\zed\windows_only_instance.rs
210            $appMutex = "Zed-Dev-Instance-Mutex"
211            $appExeName = "Zed"
212            $regValueName = "ZedDev"
213            $appUserId = "ZedIndustries.Zed.Dev"
214            $appShellNameShort = "Z&ed Dev"
215            $appAppxFullName = "ZedIndustries.Zed.Dev_1.0.0.0_neutral__japxn1gcva8rg"
216        }
217        default {
218            Write-Error "can't bundle installer for $channel."
219            exit 1
220        }
221    }
222
223    # Windows runner 2022 default has iscc in PATH, https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md
224    # Currently, we are using Windows 2022 runner.
225    # Windows runner 2025 doesn't have iscc in PATH for now, https://github.com/actions/runner-images/issues/11228
226    $innoSetupPath = "C:\Program Files (x86)\Inno Setup 6\ISCC.exe"
227
228    $definitions = @{
229        "AppId"          = $appId
230        "AppIconName"    = $appIconName
231        "OutputDir"      = "$env:ZED_WORKSPACE\target"
232        "AppSetupName"   = $appSetupName
233        "AppName"        = $appName
234        "AppDisplayName" = $appDisplayName
235        "RegValueName"   = $regValueName
236        "AppMutex"       = $appMutex
237        "AppExeName"     = $appExeName
238        "ResourcesDir"   = "$innoDir"
239        "ShellNameShort" = $appShellNameShort
240        "AppUserId"      = $appUserId
241        "Version"        = "$env:RELEASE_VERSION"
242        "SourceDir"      = "$env:ZED_WORKSPACE"
243        "AppxFullName"   = $appAppxFullName
244    }
245
246    $signTool = "powershell.exe -ExecutionPolicy Bypass -File $innoDir\sign.ps1 `$f"
247
248    $defs = @()
249    foreach ($key in $definitions.Keys) {
250        $defs += "/d$key=`"$($definitions[$key])`""
251    }
252
253    $innoArgs = @($issFilePath) + $defs + "/sDefaultsign=`"$signTool`""
254
255    # Execute Inno Setup
256    Write-Host "🚀 Running Inno Setup: $innoSetupPath $innoArgs"
257    $process = Start-Process -FilePath $innoSetupPath -ArgumentList $innoArgs -NoNewWindow -Wait -PassThru
258
259    if ($process.ExitCode -eq 0) {
260        Write-Host "✅ Inno Setup successfully compiled the installer"
261        Write-Output "SETUP_PATH=target/$appSetupName.exe" >> $env:GITHUB_ENV
262        $script:buildSuccess = $true
263    }
264    else {
265        Write-Host "❌ Inno Setup failed: $($process.ExitCode)"
266        $script:buildSuccess = $false
267    }
268}
269
270ParseZedWorkspace
271$innoDir = "$env:ZED_WORKSPACE\inno"
272$debugArchive = ".\target\release\zed-$env:RELEASE_VERSION-$env:ZED_RELEASE_CHANNEL.dbg.zip"
273$debugStoreKey = "$env:ZED_RELEASE_CHANNEL/zed-$env:RELEASE_VERSION-$env:ZED_RELEASE_CHANNEL.dbg.zip"
274
275CheckEnvironmentVariables
276PrepareForBundle
277GenerateLicenses
278BuildZedAndItsFriends
279MakeAppx
280SignZedAndItsFriends
281ZipZedAndItsFriendsDebug
282DownloadAMDGpuServices
283CollectFiles
284BuildInstaller
285
286UploadToBlobStorePublic -BucketName "zed-debug-symbols" -FileToUpload $debugArchive -BlobStoreKey $debugStoreKey
287UploadToSentry
288
289if ($buildSuccess) {
290    Write-Output "Build successful"
291    if ($Install) {
292        Write-Output "Installing Zed..."
293        Start-Process -FilePath "$env:ZED_WORKSPACE/target/ZedEditorUserSetup-x64-$env:RELEASE_VERSION.exe"
294    }
295    exit 0
296}
297else {
298    Write-Output "Build failed"
299    exit 1
300}