LT-22432: Update CD workflows to use build.ps1 (#705)

* Pass MSBuild arguments through to installer builds
* Add -BuildPatch option for building patch installers
* Remove WriteNonLocalDevelopmentPropertiesFile;
  this has long been unnecessary.
* Check for .NET 4.8 before building CD workflows
* Check for logs in the root directory
* Add WiX to the PATH at the beginning of build.ps1
* Revert a change to CustomComponents.wxi

Also
* Force all Installer builds to be Release builds
* Pass logging variables to installer builds
* Remove unused Target BuildInstallerWix3
* Organize ReadMe and fix a dead link
* Fix whitespace in Setup-Developer-Machine.ps1
* Clarify Setup-Developer-Machine.ps1
* change Base build offset to 1000:
1000 makes easier mental math than 1100, and we've
burned 100 build numbers since our last release,
so now is the time to reduce it.

FUTURE WORK (see LT-22446:)
* Prevent log file collisions from -LogPath and /bl
* Prevent redundant builds

Author: papeh

.github/workflows/base-installer-cd.yml

@@ -55,7 +55,7 @@ jobs:
       - name: Compute build number
         id: build_number
         run: |
-          $lastJenkins = 1100  # The last base build from jenkins, rounded to the next hundred
+          $lastJenkins = 1000  # The last base build from jenkins, rounded to the nearest thousand
           $githubRun = $env:GITHUB_RUN_NUMBER
           $combined = $lastJenkins + $githubRun
           echo "Calculated build number: $combined"
@@ -103,17 +103,35 @@ jobs:
           fetch-depth: 0
           path: 'Localizations/LCM'
 
-      - name: Download .NET 461 targeting pack
-        uses: suisei-cn/actions-download-file@9f75b8c2dad5ccced7509c44a3b881c5613abde2 # 1.6.1
-        id: downloadfile  # Remember to give an ID if you need the output filename
-        with:
-            url: "https://download.microsoft.com/download/F/1/D/F1DEB8DB-D277-4EF9-9F48-3A65D4D8F965/NDP461-DevPack-KB3105179-ENU.exe"
-            target: public/
+      - name: Ensure .NET Framework 4.8 targeting pack
+        shell: pwsh
+        run: |
+          # Check registry Release key for .NET Framework 4.8 (Release >= 528040 indicates 4.8)
+          $targetRelease = 528040
+          try {
+            $releaseKey = (Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full" -Name Release -ErrorAction Stop).Release
+          } catch {
+            $releaseKey = $null
+          }
 
-      - name: Install .NET 461 targeting pack
-        shell: cmd
-        working-directory: public
-        run: NDP461-DevPack-KB3105179-ENU.exe /q
+          if (-not $releaseKey -or $releaseKey -lt $targetRelease) {
+            Write-Host "Detected .NET release $releaseKey. Installing .NET Framework 4.8 Developer Pack..."
+            $installerUrl = "https://download.microsoft.com/download/9/5/0/9500E0A8-3C76-45F9-8D4B-8D2A7F2C1A3A/NDP48-DevPack-KB4486153-ENU.exe"
+            $installer = Join-Path $env:RUNNER_TEMP "NDP48-DevPack-KB4486153-ENU.exe"
+
+            Invoke-WebRequest -Uri $installerUrl -OutFile $installer -UseBasicParsing -TimeoutSec 120
+
+            Write-Host "Starting installer..."
+            $proc = Start-Process -FilePath $installer -ArgumentList "/quiet","/norestart" -Wait -PassThru
+            if ($proc.ExitCode -ne 0) {
+              Write-Error "Failed to install .NET 4.8 Developer Pack. ExitCode: $($proc.ExitCode)"
+              exit $proc.ExitCode
+            }
+            Write-Host ".NET 4.8 Developer Pack installation finished."
+          }
+          else {
+            Write-Host ".NET Framework 4.8 (Release=$releaseKey) already present. Skipping install."
+          }
 
       - name: Setup dotnet
         uses: actions/setup-dotnet@v4
@@ -134,24 +152,14 @@ jobs:
           echo "C:\Program Files (x86)\WiX Toolset v3.11\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
         if: github.event_name != 'pull_request'
 
-      - name: Prepare for build
-        shell: cmd
-        working-directory: Build
-        run: build64.bat /t:WriteNonlocalDevelopmentPropertiesFile
-
       - name: Build and run tests
         id: build_installer
         shell: powershell
         run: |
-          cd Build
-          .\build64.bat /t:BuildBaseInstaller "/property:config=release;action=test;desktopNotAvailable=true" /v:d /bl ^| tee-object -FilePath build.log
-          cd ..
-          cd BuildDir
-          md5sum *.exe > md5.txt
+          .\build.ps1 -BuildInstaller -Configuration Release -MsBuildArgs @("/p:action=test;desktopNotAvailable=true","/v:d","/bl") | Tee-Object -FilePath build.log
 
       - name: Scan Build Output
         shell: powershell
-        working-directory: Build
         run: |
           $results = Select-String -Path "build.log" -Pattern "^\s*[1-9][0-9]* Error\(s\)"
           if ($results) {
@@ -298,5 +306,5 @@ jobs:
           if-no-files-found: warn
           name: build-logs
           path: |
-            Build/*.log
-            Build/*.binlog
+            *.log
+            *.binlog

.github/workflows/patch-installer-cd.yml

@@ -8,7 +8,7 @@ name: Patch Installer
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main", "release/**"]
   schedule:
     # Runs every Monday at 03:30 UTC (which is 8:30pm MST/PDT Sunday evening)
     - cron: "30 3 * * 1"
@@ -118,17 +118,35 @@ jobs:
           fetch-depth: 0
           path: 'Localizations/LCM'
 
-      - name: Download .NET 461 targeting pack
-        uses: suisei-cn/actions-download-file@9f75b8c2dad5ccced7509c44a3b881c5613abde2 # 1.6.1
-        id: downloadfile  # Remember to give an ID if you need the output filename
-        with:
-            url: "https://download.microsoft.com/download/F/1/D/F1DEB8DB-D277-4EF9-9F48-3A65D4D8F965/NDP461-DevPack-KB3105179-ENU.exe"
-            target: public/
+      - name: Ensure .NET Framework 4.8 targeting pack
+        shell: pwsh
+        run: |
+          # Check registry Release key for .NET Framework 4.8 (Release >= 528040 indicates 4.8)
+          $targetRelease = 528040
+          try {
+            $releaseKey = (Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full" -Name Release -ErrorAction Stop).Release
+          } catch {
+            $releaseKey = $null
+          }
 
-      - name: Install .NET 461 targeting pack
-        shell: cmd
-        working-directory: public
-        run: NDP461-DevPack-KB3105179-ENU.exe /q
+          if (-not $releaseKey -or $releaseKey -lt $targetRelease) {
+            Write-Host "Detected .NET release $releaseKey. Installing .NET Framework 4.8 Developer Pack..."
+            $installerUrl = "https://download.microsoft.com/download/9/5/0/9500E0A8-3C76-45F9-8D4B-8D2A7F2C1A3A/NDP48-DevPack-KB4486153-ENU.exe"
+            $installer = Join-Path $env:RUNNER_TEMP "NDP48-DevPack-KB4486153-ENU.exe"
+
+            Invoke-WebRequest -Uri $installerUrl -OutFile $installer -UseBasicParsing -TimeoutSec 120
+
+            Write-Host "Starting installer..."
+            $proc = Start-Process -FilePath $installer -ArgumentList "/quiet","/norestart" -Wait -PassThru
+            if ($proc.ExitCode -ne 0) {
+              Write-Error "Failed to install .NET 4.8 Developer Pack. ExitCode: $($proc.ExitCode)"
+              exit $proc.ExitCode
+            }
+            Write-Host ".NET 4.8 Developer Pack installation finished."
+          }
+          else {
+            Write-Host ".NET Framework 4.8 (Release=$releaseKey) already present. Skipping install."
+          }
 
       - name: Setup dotnet
         uses: actions/setup-dotnet@v4
@@ -183,10 +201,8 @@ jobs:
           Expand-Archive -Path "base-artifacts/ProcRunner.zip" -DestinationPath $procTarget -Force
           Write-Host "Expanded ProcRunner.zip -> $procTarget"
 
-      # Write out the properties file (a first build on a system requires a prompt response otherwise)
-      # and set an OS feature in the registry that will allow Wix v3 to use temporary files without error
+      # Set an OS feature in the registry that will allow Wix v3 to use temporary files without error
       - name: Prepare for build
-        working-directory: Build
         run: |
           # Define paths and the key/value to set
           $regPaths = @(
@@ -203,22 +219,16 @@ jobs:
               }
               New-ItemProperty -Path $path -Name $valueName -Value $expectedValue -Type String -Force
           }
-          
-          .\build64.bat /t:WriteNonlocalDevelopmentPropertiesFile
 
       - name: Build Debug and run tests
         id: build_installer
         shell: powershell
         run: |
           Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\.NETFramework\AppContext"
-          cd Build
-          .\build64.bat /t:BuildPatchInstaller  "/property:config=release;action=test;desktopNotAvailable=true" /v:d /bl ^| tee-object -FilePath build.log
-          cd ..
-          cd BuildDir
+          .\build.ps1 -BuildPatch -Configuration Release -MsBuildArgs @("/p:action=test;desktopNotAvailable=true","/v:d","/bl") | Tee-Object -FilePath build.log
 
       - name: Scan Debug Build Output
         shell: powershell
-        working-directory: Build
         run: |
           $results = Select-String -Path "build.log" -Pattern "^\s*[1-9][0-9]* Error\(s\)"
           if ($results) {
@@ -281,5 +291,5 @@ jobs:
           if-no-files-found: warn
           name: build-logs
           path: |
-            Build/*.log
-            Build/*.binlog
+            *.log
+            *.binlog

.gitignore

@@ -54,7 +54,6 @@ x64
 *.user
 *.ncrunchsolution
 *.ncb
-FW.sln
 *.suo
 *.o
 *_ReSharper*
@@ -89,6 +88,7 @@ buildi686/
 buildx86_64/
 installi686/
 installx86_64/
+msbuild.binlog
 test-results/
 trash/
 UpgradeLog*.XML

Build/Installer.Wix3.targets

@@ -28,5 +28,5 @@
   </Target>
 
   <Target Name="BuildInstaller" DependsOnTargets="VerifyWix3Inputs;BuildBaseInstaller" />
-  <Target Name="BuildInstallerWix3" DependsOnTargets="VerifyWix3Inputs;BuildBaseInstaller" />
+  <Target Name="BuildPatch" DependsOnTargets="VerifyWix3Inputs;BuildPatchInstaller" />
 </Project>

Build/Installer.legacy.targets

@@ -100,8 +100,8 @@
 			Condition="'$(Platform)' != 'x64'"
 		/>
 		<Error
-			Text="Installer must be run for release builds [config=$(config)]"
-			Condition="'$(config)' != 'release'"
+			Text="Installer must be run for release builds [config=$(config); Configuration=$(Configuration)]"
+			Condition="'$(config)' != 'release' or '$(Configuration)' != 'Release'"
 		/>
 	</Target>
 	<!--

Build/InstallerBuild.proj

@@ -15,7 +15,7 @@
 
   <PropertyGroup>
     <Platform Condition="'$(Platform)'==''">x64</Platform>
-    <Configuration Condition="'$(Configuration)'==''">Debug</Configuration>
+    <Configuration Condition="'$(Configuration)'==''">Release</Configuration>
     <InstallerToolset Condition="'$(InstallerToolset)'==''">Wix3</InstallerToolset>
   </PropertyGroup>
 

Build/Localize.targets

@@ -36,6 +36,8 @@
 		<GoldEticDir>$(ListsDirectory)/GramCats</GoldEticDir>
 		<MessagesPot>$(L10nsBaseDir)/messages.pot</MessagesPot>
 		<LcmSrcDir>$(LcmRootDir)/src</LcmSrcDir>
+		<WarnForMissingDD Condition="'$(DownloadsDir)'==''">true</WarnForMissingDD>
+		<DownloadsDir>$(fwrt)/Downloads</DownloadsDir><!-- TODO (Hasso) 2026.02: figure out why this isn't getting set elsewhere -->
 		<CrowdinZip>$(DownloadsDir)/Crowdin.zip</CrowdinZip>
 		<CrowdinApiKey>$(CROWDIN_API_KEY)</CrowdinApiKey>
 		<DisableLocalization Condition="'$(DisableLocalization)'=='' and '$(CrowdinApiKey)'==''">true</DisableLocalization>
@@ -114,6 +116,7 @@ To update localizations, liblcm must be cloned locally to the location specified
 		DependsOnTargets="ValidateCrowdinApiKey;InstallOvercrowdin"
 	>
 		<ForceDelete Files="$(L10nsDirectory)" />
+		<Warn Condition="'$(WarnForMissingDD)'=='true'" Text="WARNING: DownloadsDir was not set when $(MSBuildThisFile) was loaded"/>
 		<MakeDir Directories="$(DownloadsDir)" />
 		<Exec
 			WorkingDirectory="$(fwrt)"

Build/SetupInclude.targets

@@ -15,11 +15,10 @@
 	</PropertyGroup>
 	<PropertyGroup>
 		<IcuVersion>70</IcuVersion>
-		<!-- Only compute fwrt if not already set (e.g., by NativeBuild.csproj) -->
-		<fwrt Condition="'$(fwrt)' == ''"
-			>$([System.IO.Directory]::GetParent($(MSBuildProjectDirectory)))</fwrt
-		>
+		<!-- Compute fwrt only if not already set (e.g., by NativeBuild.csproj) -->
+		<fwrt Condition="'$(fwrt)' == ''">$([System.IO.Directory]::GetParent($(MSBuildProjectDirectory)))</fwrt>
 		<fwrt Condition="'$(fwrt)' == ''">$(MSBuildThisFileDirectory)..</fwrt>
+		<DownloadsDir>$(fwrt)/Downloads</DownloadsDir>
 	</PropertyGroup>
 	<!--
 		Configuration Synchronization:

FLExInstaller/CustomComponents.wxi

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<?if $(var.BuildArch) = x64 ?>
+<?if $(sys.BUILDARCH) = x64 ?>
 <?define EncodingConvertersPath = "..\..\packages\encoding-converters-core\0.9.7\runtimes\EcDistFiles\MergeModules\x64\Release" ?>
 <?else?>
 <?define EncodingConvertersPath = "..\..\packages\encoding-converters-core\0.9.7\runtimes\EcDistFiles\MergeModules\x86\Release" ?>
@@ -110,7 +110,7 @@
 	</ComponentGroup>
 
 	<DirectoryRef  Id='APPFOLDER'>
-		<?if $(var.BuildArch) = x64 ?>
+		<?if $(sys.BUILDARCH) = x64 ?>
 		<Merge Id="CC_DLL" Language="1033" SourceFile="$(var.EncodingConvertersPath)\CcDLLs64bitMM.msm" DiskId="1"/>
 		<Merge Id="EncConverters_Common" Language="1033" SourceFile="$(var.EncodingConvertersPath)\EC_40_64bit_MM.msm" DiskId="1"/>
 		<Merge Id="PerlEC" Language="1033" SourceFile="$(var.EncodingConvertersPath)\PerlEc64bitMM.msm" DiskId="1"/>

ReadMe.md

@@ -13,14 +13,30 @@ New to FieldWorks development? Start here:
 
 For first-time setup on a Windows development machine:
 
+- Install required software:
+	- Visual Studio 2022 with .NET desktop and C++ desktop workloads
+	- Git for Windows
+- Run the setup script:
 ```powershell
 # Run as Administrator (or User for user-level PATH)
 .\Setup-Developer-Machine.ps1
 ```
 
-This configures a dev machine for builds and tests (verifies prerequisites and configures PATH). Prerequisites:
-- Visual Studio 2022 with .NET desktop and C++ desktop workloads
-- Git for Windows
+This configures a dev machine for builds and tests (verifies prerequisites and configures PATH).
+
+## Building FieldWorks
+
+FieldWorks uses the **MSBuild Traversal SDK** for declarative, dependency-ordered builds:
+
+**Windows (PowerShell):**
+```powershell
+.\build.ps1                    # Debug build
+.\build.ps1 -Configuration Release
+```
+
+For detailed build instructions, see [.github/instructions/build.instructions.md](.github/instructions/build.instructions.md).
+
+## Building Installers (WiX 3 default, WiX 6 opt-in)
 
 Installer builds default to **WiX 3** (legacy batch pipeline) using inputs in `FLExInstaller/` and `PatchableInstaller/`. The **Visual Studio WiX Toolset v3 extension** is required so `Wix.CA.targets` is available under the MSBuild extensions path. Use `-InstallerToolset Wix6` to opt into the WiX 6 SDK-style path (restored via NuGet).
 
@@ -37,35 +53,17 @@ Required:
 - Add the toolset root to `PATH` (or rerun `Setup-Developer-Machine.ps1` to do it for you).
 - Install the **Visual Studio WiX Toolset v3 extension** so `Wix.CA.targets` is available to MSBuild.
 
-## Building FieldWorks
-
-FieldWorks uses the **MSBuild Traversal SDK** for declarative, dependency-ordered builds:
-
-**Windows (PowerShell):**
-```powershell
-.\build.ps1                    # Debug build
-.\build.ps1 -Configuration Release
-```
-
-For detailed build instructions, see [.github/instructions/build.instructions.md](.github/instructions/build.instructions.md).
-
-## Building Installers (WiX 3 default, WiX 6 opt-in)
+### Running installer builds
 
 Installer builds include the additional utilities (UnicodeCharEditor, LCMBrowser, MigrateSqlDbs, etc.).
 To skip them, pass `-BuildAdditionalApps:$false`.
 
 ```powershell
-# Build the installer (Debug, WiX 3 default)
+# Build the installer (WiX 3 default)
 .\build.ps1 -BuildInstaller
 
-# Build the installer (Debug, WiX 6)
+# Build the installer (WiX 6)
 .\build.ps1 -BuildInstaller -InstallerToolset Wix6
-
-# Build the installer (Release, WiX 3 default)
-.\build.ps1 -BuildInstaller -Configuration Release
-
-# Build the installer (Release, WiX 6)
-.\build.ps1 -BuildInstaller -Configuration Release -InstallerToolset Wix6
 ```
 
 WiX 3 artifacts are produced under `FLExInstaller/bin/x64/<Config>/` (MSI under `en-US/`).