WiX release notes
WiX v4 Release Candidate 2
Release Candidate 2 released Friday, 20-January-2023
WiX v4 Release Candidate 2 contains fixes for bugs that were reported during Release Candidate 1. There are two new features:
Package/@Scopeoptions for dual-scope, single-package authoring. See issue #7137, @robmen's code PR, and documentation PR.
DotNetCoreSdkSearchBurn search to locate .NET (Core) SDKs, like the
DotNetCoreSearchsearch for .NET runtimes. See issue #7058, @powercode's code PR, and @rseanhall's documentation PR.
Update MSBuild projects
To update your .wixproj MSBuild projects, update the
PackageReferences to WiX v4 extensions, update their
Version attribute. For example:
<PackageReference Include="WixToolset.Util.wixext" Version="4.0.0-rc.2" />
<PackageReference Include="WixToolset.Netfx.wixext" Version="4.0.0-rc.2" />
To clean up the NuGet artifacts from previous prereleases of WiX v4, we recommend you delete the
obj directories in your projects. If you're using .NET Framework MSBuild, do an explicit
MSBuild -Restore to get Release Candidate 2 restored. (Using
dotnet build does that implicitly for you.)
Update the WiX .NET tool
To update your .NET tool installation of WiX v4 Release Candidate 2:
dotnet tool update --global wix --version 4.0.0-rc.2
To install WiX for the first time as a .NET tool:
dotnet tool install --global wix --version 4.0.0-rc.2
To verify Wix.exe was successfully installed or updated:
Update HeatWave Community Edition
To upgrade HeatWave Community Edition with support for WiX v4 Release Candidate 2, see the FireGiant blog post with details.
Note that HeatWave v0.9.4 is required to match changes made in the WiX v4 RC2 MSBuild targets.
WiX v4 Release Candidate 1
Release Candidate 1 released Friday, 16-December-2022
WiX v4 Release Candidate 1 contains fixes for bugs that were reported during Preview 1. There are no new features.
WiX v4 Preview 1
Preview 1 released Friday, 11-November-2022
WiX v4 is a major release of the WiX Toolset, years in the making. More than 500 issues were closed in WiX v4!
If you're familiar with WiX v3, WiX v4 for WiX v3 users has details about how WiX v4 works.
Here's a high-level look at the fixes and features in WiX v4:
- Arm64 is supported in the core toolset, extensions, and Burn.
- WiX extensions include platform-specific custom actions for the platform of the package being built. For example, an Arm64 package contains only Arm64 custom actions and doesn't rely on x86 emulation.
- WiX v4 doesn't have to be installed on every dev machine and build image like WiX v3. Instead, WiX v4 follows the modern .NET model of using NuGet to deliver tools.
- WiX v4 MSBuild projects are SDK-style projects; MSBuild and NuGet work together to bring down the WiX v4 MSBuild SDK NuGet package.
- Both .NET Framework MSBuild and
dotnet buildare supported.
- To build packages from the command line, WiX v4 is available as a .NET tool, which is also a NuGet package.
- WiX extensions are delivered as NuGet packages, which are usable from both MSBuild projects via
PackageReferenceand the WiX .NET tool.
- For command-line afficionados, most executables have been merged into a single
wix.exetool with commands. For example, in WiX v3, you might build by calling Candle.exe one or more times to compile your authoring and then calling Light.exe to link and bind the compiled authoring into an .msi package. In WiX v4 using
wix.exe, that's one command:
wix build -o product.msi product.wxs.
- Building patches is much easier (one command!) and can use MSI packages as the source of target and updated files.
- The WiX extensibility model and pipeline integration has been dramatically enhanced.
- The WiX language has been further simplified. For example:
Packageelement combines what was two elements in WiX v3.
StandardDirectoryelement simplifies the use of standard Windows Installer directories.
Subdirectoryattribute on, for example, the
Componentelement, lets you create subdirectories without nested
- WiX supplies a default
MediaTemplateelement if you don't specify one in your authoring.
- WiX warns when mixing authoring meant for MSI packages in bundles and vice versa.
Burn, bundles, and bootstrapper applications
- The Burn engine is platform-specific, so you can build an x64 bundle that contains only x64 code and doesn't rely on WoW64.
- .NET 6 and later are supported platforms for writing managed-code bootstrapper applications. .NET Framework is also supported.
- ThmUtil, the native-code UI library used by the WixStdBA bootstrapper application, supports new controls and authored conditions and actions that let themes add functionality without having to write custom C++ code. For details, see Thmutil schema.
- ThmUtil (and therefore WixStdBA) supports high DPI display settings.
- The new
WixInternalUIBootstrapperApplicationBA supports showing only the internal or embedded UI of an MSI package.
- Burn support other bundles in the chain via
BundlePackageto automatically handle detection and uninstall command lines. Likewise, the
ArpEntryelement provides the same functionality for arbitrary executable packages in the chain.
- Burn supports SemVer-style versions.
- WixStdBA supports bundle update feeds as specified in an
- Burn now upgrades bundles with the same version numbers.
- When a user requires elevation to restart (common on Windows Server machines), Burn handles restart through the elevated engine.
- Custom bootstrapper applications can change the
REINSTALLMODEused when applying MSI packages.
- The Burn policy registry value
HKLM\Software\Policies\Wix\Burnis a string specifying a working folder root directory for elevated bundles when the default of
C:\Windows\Tempis blocked by security policy.
- Burn no longer appears in the Apps & Features (ARP) list if a bundle has a pre-req that causes a reboot and the user cancels after the reboot.
/unsafeuninstallcommand-line switch lets users attempt to "force" a bundle to uninstall, even if dependency checking would otherwise leave it installed.
Deprecations and deletions
- Features that were deprecated in WiX v3, including command-line switches deprecated in WiX v3.14, have been removed from WiX v4.
- WixGamingExtension and WixLuxExtension have been removed in WiX v4.
- WixDifxAppExtension is deprecated in Windows 10 and therefore has been deprecated in WiX v4 and will be removed in WiX v5.