[Installer] Upgrade the installer from WiX3 to WiX5 (#40877)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request
Background: The current PowerToys installer is built using Wix3, which
has now been deprecated. To improve security, service quality, and
community support, we’re upgrading the installer to Wix5.
Implementation:
Created Wix5-based projects(PowerToysSetupVext and
PowerToysSetupCustomActionsVNext) within the installer while retaining
the existing Wix3 project. Both versions are built to generate separate
installation packages. The Wix3-related code will be removed after
successful release testing confirms no issues.
Special case:
Wix5 has removed the property for 'ShowFilesInUse'. Now, whenever a file
is in use during installation, a FilesInUse pop-upwill automatically
appear asking for the next step. To ensure this doesn't interfere with
scenarios that require silent installation (e.g. Winget method), we’ve
handled it using the bafunction approach.
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
- [ ] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx
<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
---------
Co-authored-by: Jerry Xu <n.xu@outlook.com>
Co-authored-by: Kai Tao <69313318+vanzue@users.noreply.github.com>
Co-authored-by: leileizhang <leilzh@microsoft.com>
Co-authored-by: Kai Tao (from Dev Box) <kaitao@microsoft.com>
Co-authored-by: vanzue <vanzue@outlook.com>
2025-08-25 18:39:11 +08:00
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
<Project DefaultTargets= "Build" xmlns= "http://schemas.microsoft.com/developer/msbuild/2003" >
<ItemGroup Label= "ProjectConfigurations" >
<ProjectConfiguration Include= "Debug|ARM64" >
<Configuration > Debug</Configuration>
<Platform > ARM64</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include= "Release|ARM64" >
<Configuration > Release</Configuration>
<Platform > ARM64</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include= "Debug|x64" >
<Configuration > Debug</Configuration>
<Platform > x64</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include= "Release|x64" >
<Configuration > Release</Configuration>
<Platform > x64</Platform>
</ProjectConfiguration>
</ItemGroup>
<PropertyGroup Label= "Globals" >
<ProjectGuid > {F8B9F842-F5C3-4A2D-8C85-7F8B9E2B4F1D}</ProjectGuid>
<ConfigurationType > DynamicLibrary</ConfigurationType>
<CharacterSet > Unicode</CharacterSet>
<TargetName > SilentFilesInUseBAFunction</TargetName>
2025-09-25 05:49:58 -07:00
<ProjectName > PowerToysSetupCustomActionsVNext</ProjectName>
[Installer] Upgrade the installer from WiX3 to WiX5 (#40877)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request
Background: The current PowerToys installer is built using Wix3, which
has now been deprecated. To improve security, service quality, and
community support, we’re upgrading the installer to Wix5.
Implementation:
Created Wix5-based projects(PowerToysSetupVext and
PowerToysSetupCustomActionsVNext) within the installer while retaining
the existing Wix3 project. Both versions are built to generate separate
installation packages. The Wix3-related code will be removed after
successful release testing confirms no issues.
Special case:
Wix5 has removed the property for 'ShowFilesInUse'. Now, whenever a file
is in use during installation, a FilesInUse pop-upwill automatically
appear asking for the next step. To ensure this doesn't interfere with
scenarios that require silent installation (e.g. Winget method), we’ve
handled it using the bafunction approach.
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
- [ ] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx
<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
---------
Co-authored-by: Jerry Xu <n.xu@outlook.com>
Co-authored-by: Kai Tao <69313318+vanzue@users.noreply.github.com>
Co-authored-by: leileizhang <leilzh@microsoft.com>
Co-authored-by: Kai Tao (from Dev Box) <kaitao@microsoft.com>
Co-authored-by: vanzue <vanzue@outlook.com>
2025-08-25 18:39:11 +08:00
<ProjectModuleDefinitionFile > bafunctions.def</ProjectModuleDefinitionFile>
<WindowsTargetPlatformVersion > 10.0</WindowsTargetPlatformVersion>
</PropertyGroup>
<Import Project= "$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
<!-- Configuration - specific property groups -->
<PropertyGroup Condition= "'$(Configuration)'=='Debug'" Label= "Configuration" >
<ConfigurationType > DynamicLibrary</ConfigurationType>
<UseDebugLibraries > true</UseDebugLibraries>
<PlatformToolset > v143</PlatformToolset>
<CharacterSet > Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition= "'$(Configuration)'=='Release'" Label= "Configuration" >
<ConfigurationType > DynamicLibrary</ConfigurationType>
<UseDebugLibraries > false</UseDebugLibraries>
<PlatformToolset > v143</PlatformToolset>
<WholeProgramOptimization > true</WholeProgramOptimization>
<CharacterSet > Unicode</CharacterSet>
</PropertyGroup>
<Import Project= "$(VCTargetsPath)\Microsoft.Cpp.props" />
<PropertyGroup >
<ProjectAdditionalLinkLibraries > comctl32.lib;gdiplus.lib;msimg32.lib;shlwapi.lib;wininet.lib;version.lib</ProjectAdditionalLinkLibraries>
</PropertyGroup>
<ItemGroup >
<ProjectCapability Include= "PackageReferences" />
</ItemGroup>
<PropertyGroup >
<NuGetTargetMoniker Condition= "'$(NuGetTargetMoniker)' == ''" >
native,Version=v0.0
</NuGetTargetMoniker>
<RuntimeIdentifiers > win-x64;win-arm64</RuntimeIdentifiers>
</PropertyGroup>
<ItemGroup >
<ClCompile Include= "SilentFilesInUseBAFunctions.cpp" />
<ClCompile Include= "bafunctions.cpp" >
<PrecompiledHeader > Create</PrecompiledHeader>
<PrecompiledHeaderFile > precomp.h</PrecompiledHeaderFile>
</ClCompile>
</ItemGroup>
<ItemGroup >
<ClInclude Include= "precomp.h" />
<ClInclude Include= "resource.h" />
</ItemGroup>
<ItemGroup >
<None Include= "bafunctions.def" />
<None Include= "Readme.txt" />
</ItemGroup>
<ItemGroup >
<PackageReference Include= "WixToolset.BootstrapperApplicationApi" />
<PackageReference Include= "WixToolset.WixStandardBootstrapperApplicationFunctionApi" />
</ItemGroup>
<ItemDefinitionGroup >
<Link >
<AdditionalDependencies > version.lib;%(AdditionalDependencies)</AdditionalDependencies>
<ModuleDefinitionFile > bafunctions.def</ModuleDefinitionFile>
</Link>
</ItemDefinitionGroup>
2025-09-25 05:49:58 -07:00
<!-- C++ source compile - specific things for Debug/Release configurations -->
<ItemDefinitionGroup Condition= "'$(Configuration)'=='Debug'" >
<ClCompile >
<PreprocessorDefinitions > _DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<Optimization > Disabled</Optimization>
<RuntimeLibrary > MultiThreadedDebug</RuntimeLibrary>
</ClCompile>
<Link >
<GenerateDebugInformation > true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition= "'$(Configuration)'=='Release'" >
<ClCompile >
<PreprocessorDefinitions > NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<Optimization > MaxSpeed</Optimization>
<RuntimeLibrary > MultiThreaded</RuntimeLibrary>
<FunctionLevelLinking > true</FunctionLevelLinking>
<IntrinsicFunctions > true</IntrinsicFunctions>
</ClCompile>
<Link >
<GenerateDebugInformation > true</GenerateDebugInformation>
<EnableCOMDATFolding > true</EnableCOMDATFolding>
<OptimizeReferences > true</OptimizeReferences>
</Link>
</ItemDefinitionGroup>
[Installer] Upgrade the installer from WiX3 to WiX5 (#40877)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request
Background: The current PowerToys installer is built using Wix3, which
has now been deprecated. To improve security, service quality, and
community support, we’re upgrading the installer to Wix5.
Implementation:
Created Wix5-based projects(PowerToysSetupVext and
PowerToysSetupCustomActionsVNext) within the installer while retaining
the existing Wix3 project. Both versions are built to generate separate
installation packages. The Wix3-related code will be removed after
successful release testing confirms no issues.
Special case:
Wix5 has removed the property for 'ShowFilesInUse'. Now, whenever a file
is in use during installation, a FilesInUse pop-upwill automatically
appear asking for the next step. To ensure this doesn't interfere with
scenarios that require silent installation (e.g. Winget method), we’ve
handled it using the bafunction approach.
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
- [ ] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx
<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
---------
Co-authored-by: Jerry Xu <n.xu@outlook.com>
Co-authored-by: Kai Tao <69313318+vanzue@users.noreply.github.com>
Co-authored-by: leileizhang <leilzh@microsoft.com>
Co-authored-by: Kai Tao (from Dev Box) <kaitao@microsoft.com>
Co-authored-by: vanzue <vanzue@outlook.com>
2025-08-25 18:39:11 +08:00
<Import Project= "$(VCTargetsPath)\Microsoft.Cpp.targets" />
</Project>