use DSCModules and remove the installlocation change

2026-02-23 19:49:43 +01:00 · 2025-11-05 11:25:33 +08:00
parent eaf286fa12
commit 6499130fe8
9 changed files with 56 additions and 45 deletions
--- a/.pipelines/generateDscManifests.ps1
+++ b/.pipelines/generateDscManifests.ps1
@@ -65,10 +65,10 @@ if (-not (Test-Path $outputDir)) {
    New-Item -Path $outputDir -ItemType Directory -Force | Out-Null
 }

-# DSC v3 manifests go to DSCv3 subfolder
-$dscOutputDir = Join-Path $outputDir 'DSCv3'
+# DSC v3 manifests go to DSCModules subfolder
+$dscOutputDir = Join-Path $outputDir 'DSCModules'
 if (-not (Test-Path $dscOutputDir)) {
-    Write-Host "Creating DSCv3 subfolder at '$dscOutputDir'."
+    Write-Host "Creating DSCModules subfolder at '$dscOutputDir'."
    New-Item -Path $dscOutputDir -ItemType Directory -Force | Out-Null
 }

--- a/installer/PowerToysSetupCustomActionsVNext/CustomAction.cpp
+++ b/installer/PowerToysSetupCustomActionsVNext/CustomAction.cpp
@@ -1672,16 +1672,14 @@ UINT __stdcall SetBundleInstallLocationCA(MSIHANDLE hInstall)
                
                if (_wcsicmp(regUpgradeCode.c_str(), bundleUpgradeCode.c_str()) == 0)
                {
-                    // Found matching Bundle, set InstallLocation to DSCv3 subfolder for DSC v3 resource discovery
-                    std::wstring dscv3Location = installationFolder + L"DSCv3";
-                    
+                    // Found matching Bundle, set InstallLocation
                    LONG setResult = RegSetValueExW(productKey, L"InstallLocation", 0, REG_SZ,
-                                 reinterpret_cast<const BYTE*>(dscv3Location.c_str()),
-                                 static_cast<DWORD>((dscv3Location.length() + 1) * sizeof(wchar_t)));
+                                 reinterpret_cast<const BYTE*>(installationFolder.c_str()),
+                                 static_cast<DWORD>((installationFolder.length() + 1) * sizeof(wchar_t)));
                    
                    if (setResult == ERROR_SUCCESS)
                    {
-                        WcaLog(LOGMSG_STANDARD, "SetBundleInstallLocationCA: InstallLocation set to DSCv3 subfolder successfully");
+                        WcaLog(LOGMSG_STANDARD, "SetBundleInstallLocationCA: InstallLocation set successfully");
                    }
                    else
                    {
--- a/installer/PowerToysSetupVNext/Core.wxs
+++ b/installer/PowerToysSetupVNext/Core.wxs
@@ -15,8 +15,8 @@
        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
          <RegistryValue Type="string" Name="powertoys_env_path_user" Value="" KeyPath="yes" />
        </RegistryKey>
-        <!-- Append DSCv3 folder to current user's PATH for DSC v3 usage -->
-        <Environment Id="AddPowerToysToUserPath" Name="PATH" Action="set" Part="last" System="no" Value="[DSCv3Folder]" />
+        <!-- Append DSCModules folder to current user's PATH for DSC v3 usage -->
+        <Environment Id="AddPowerToysToUserPath" Name="PATH" Action="set" Part="last" System="no" Value="[DSCModulesReferenceFolder]" />
      </Component>
      <?else?>
      <Component Id="powertoys_env_path_machine" Bitness="always64">
@@ -24,8 +24,8 @@
        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
          <RegistryValue Type="string" Name="powertoys_env_path_machine" Value="" KeyPath="yes" />
        </RegistryKey>
-        <!-- Append DSCv3 folder to machine PATH for DSC v3 usage -->
-        <Environment Id="AddPowerToysToMachinePath" Name="PATH" Action="set" Part="last" System="yes" Value="[DSCv3Folder]" />
+        <!-- Append DSCModules folder to machine PATH for DSC v3 usage -->
+        <Environment Id="AddPowerToysToMachinePath" Name="PATH" Action="set" Part="last" System="yes" Value="[DSCModulesReferenceFolder]" />
      </Component>
      <?endif?>
      <Component Id="powertoys_toast_clsid" Bitness="always64">
@@ -63,16 +63,6 @@
      </Component>
    </DirectoryRef>

-    <DirectoryRef Id="DSCModulesReferenceFolder">
-      <Component Id="PowerToysDSCReference" Guid="40869ACB-0BEB-4911-AE41-5E73BC1586A9" Bitness="always64">
-        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
-          <RegistryValue Type="string" Name="DSCModulesReference" Value="" KeyPath="yes" />
-        </RegistryKey>
-        <File Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version).0\Microsoft.PowerToys.Configure.psd1" Id="PTConfReference.psd1" />
-        <File Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version).0\Microsoft.PowerToys.Configure.psm1" Id="PTConfReference.psm1" />
-      </Component>
-    </DirectoryRef>
-
    <?if $(var.PerUser) = "true" ?>
    <!-- DSC module files for PerUser handled in InstallDSCModule custom action. -->
    <?else?>
@@ -121,7 +111,6 @@
        </RegistryKey>
        <RemoveFolder Id="RemoveBaseApplicationsAssetsFolder" Directory="BaseApplicationsAssetsFolder" On="uninstall" />
        <RemoveFolder Id="RemoveDSCModulesReferenceFolder" Directory="DSCModulesReferenceFolder" On="uninstall" />
-        <RemoveFolder Id="RemoveDSCv3Folder" Directory="DSCv3Folder" On="uninstall" />
        <RemoveFolder Id="RemoveWinUI3AppsInstallFolder" Directory="WinUI3AppsInstallFolder" On="uninstall" />
        <RemoveFolder Id="RemoveWinUI3AppsAssetsFolder" Directory="WinUI3AppsAssetsFolder" On="uninstall" />
        <RemoveFolder Id="RemoveINSTALLFOLDER" Directory="INSTALLFOLDER" On="uninstall" />
@@ -138,7 +127,6 @@
      <ComponentRef Id="License_rtf" />
      <ComponentRef Id="Notice_md" />
      <ComponentRef Id="DesktopShortcut" />
-      <ComponentRef Id="PowerToysDSCReference" />
      <?if $(var.PerUser) = "false" ?>
      <ComponentRef Id="PowerToysDSC" />
      <?endif?>
--- a/installer/PowerToysSetupVNext/DscResources.wxs
+++ b/installer/PowerToysSetupVNext/DscResources.wxs
@@ -3,15 +3,25 @@
  <?include $(sys.CURRENTDIR)\Common.wxi?>

  <?define DscJsonFiles=?>
-  <?define DscJsonFilesPath=$(var.BinDir)DSCv3\?>
+  <?define DscJsonFilesPath=$(var.BinDir)?>

  <Fragment>
-    <DirectoryRef Id="DSCv3Folder" FileSource="$(var.DscJsonFilesPath)">
-    <!-- Generated by generateAllFileComponents.ps1 -->
-    <!--DscJsonFiles_Component_Def-->
+    <DirectoryRef Id="DSCModulesReferenceFolder" FileSource="$(var.DscJsonFilesPath)">
+      <!-- DSC v2 PowerShell module files -->
+      <Component Id="PowerToysDSCReference" Guid="40869ACB-0BEB-4911-AE41-5E73BC1586A9" Bitness="always64">
+        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
+          <RegistryValue Type="string" Name="DSCModulesReference" Value="" KeyPath="yes" />
+        </RegistryKey>
+        <File Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version).0\Microsoft.PowerToys.Configure.psd1" Id="PTConfReference.psd1" />
+        <File Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version).0\Microsoft.PowerToys.Configure.psm1" Id="PTConfReference.psm1" />
+      </Component>
+      
+      <!-- DSC v3 JSON manifest files - Generated by generateAllFileComponents.ps1 -->
+      <!--DscJsonFiles_Component_Def-->
    </DirectoryRef>

    <ComponentGroup Id="DscResourcesComponentGroup">
+      <ComponentRef Id="PowerToysDSCReference" />
    </ComponentGroup>
  </Fragment>
 </Wix>
--- a/installer/PowerToysSetupVNext/Product.wxs
+++ b/installer/PowerToysSetupVNext/Product.wxs
@@ -279,7 +279,6 @@
          <Directory Id="BaseApplicationsAssetsFolder" Name="Assets">
          </Directory>
          <Directory Id="DSCModulesReferenceFolder" Name="DSCModules" />
-          <Directory Id="DSCv3Folder" Name="DSCv3" />
          <Directory Id="WinUI3AppsInstallFolder" Name="WinUI3Apps">
              <Directory Id="WinUI3AppsMicrosoftUIXamlInstallFolder" Name="Microsoft.UI.Xaml">
                <Directory Id="WinUI3AppsMicrosoftUIXamlAssetsInstallFolder" Name="Assets" />
--- a/installer/PowerToysSetupVNext/generateAllFileComponents.ps1
+++ b/installer/PowerToysSetupVNext/generateAllFileComponents.ps1
@@ -316,6 +316,6 @@ Generate-FileComponents -fileListName "SettingsV2OOBEAssetsFluentIconsFiles" -wx
 Generate-FileList -fileDepsJson "" -fileListName WorkspacesImagesComponentFiles -wxsFilePath $PSScriptRoot\Workspaces.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\Assets\Workspaces\"
 Generate-FileComponents -fileListName "WorkspacesImagesComponentFiles" -wxsFilePath $PSScriptRoot\Workspaces.wxs

-#DSC Resources - JSON manifest files in DSCv3 subfolder
-Generate-FileList -fileDepsJson "" -fileListName DscJsonFiles -wxsFilePath $PSScriptRoot\DscResources.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\DSCv3\"
+#DSC Resources - JSON manifest files in DSCModules subfolder
+Generate-FileList -fileDepsJson "" -fileListName DscJsonFiles -wxsFilePath $PSScriptRoot\DscResources.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\DSCModules\"
 Generate-FileComponents -fileListName "DscJsonFiles" -wxsFilePath $PSScriptRoot\DscResources.wxs
--- a/installer/PowerToysSetupVNext/generateDscResourcesWxs.ps1
+++ b/installer/PowerToysSetupVNext/generateDscResourcesWxs.ps1
@@ -9,21 +9,28 @@ Param(
 )

 $ErrorActionPreference = 'Stop'
+
 $scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
-$buildOutputDir = Join-Path $scriptDir "..\..\$Platform\$Configuration"
+
+# Find build output directory with DSCModules subfolder
+$buildOutputDir = Join-Path $scriptDir "..\..\$Platform\$Configuration\DSCModules"

 if (-not (Test-Path $buildOutputDir)) {
    Write-Error "Build output directory not found: '$buildOutputDir'"
    exit 1
 }

+# Find all DSC manifest JSON files
 $dscFiles = Get-ChildItem -Path $buildOutputDir -Filter "microsoft.powertoys.*.settings.dsc.resource.json" -File

 if (-not $dscFiles) {
    Write-Warning "No DSC manifest files found in '$buildOutputDir'"
+    # Create empty component group
    $wxsContent = @"
-<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+
  <?include `$(sys.CURRENTDIR)\Common.wxi?>
+
  <Fragment>
    <ComponentGroup Id="DscResourcesComponentGroup">
    </ComponentGroup>
@@ -36,27 +43,32 @@ if (-not $dscFiles) {

 Write-Host "Found $($dscFiles.Count) DSC manifest file(s)"

+# Generate WiX fragment
 $wxsContent = @"
-<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+
  <?include `$(sys.CURRENTDIR)\Common.wxi?>
+
  <Fragment>
    <DirectoryRef Id="DSCModulesReferenceFolder">
 "@

 $componentRefs = @()
+
 foreach ($file in $dscFiles) {
    $componentId = "DscResource_" + ($file.BaseName -replace '[^A-Za-z0-9_]', '_')
    $fileId = $componentId + "_File"
    $guid = [System.Guid]::NewGuid().ToString().ToUpper()
+    
    $componentRefs += $componentId
    
    $wxsContent += @"

-      <Component Id="$componentId" Guid="{$guid}">
+      <Component Id="$componentId" Guid="{$guid}" Directory="DSCModulesReferenceFolder">
        <RegistryKey Root="`$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
          <RegistryValue Type="string" Name="$componentId" Value="" KeyPath="yes"/>
        </RegistryKey>
-        <File Id="$fileId" Source="`$(var.BinDir)$($file.Name)" Vital="no"/>
+        <File Id="$fileId" Source="`$(var.BinDir)DSCModules\$($file.Name)" Vital="no"/>
      </Component>
 "@
 }
@@ -65,6 +77,7 @@ $wxsContent += @"

    </DirectoryRef>
  </Fragment>
+
  <Fragment>
    <ComponentGroup Id="DscResourcesComponentGroup">
 "@
@@ -83,5 +96,7 @@ $wxsContent += @"
 </Wix>
 "@

+# Write the WiX file
 Set-Content -Path $dscWxsFile -Value $wxsContent
+
 Write-Host "Generated DSC resources WiX fragment: '$dscWxsFile'"
--- a/src/dsc/v3/PowerToys.DSC/PowerToys.DSC.csproj
+++ b/src/dsc/v3/PowerToys.DSC/PowerToys.DSC.csproj
@@ -40,10 +40,11 @@
    </EmbeddedResource>
  </ItemGroup>

-  <!-- Generate the DSC resource JSON files for both Debug and Release builds -->
-  <Target Name="GenerateDscResourceJsonFiles" AfterTargets="Build" Condition="'$(Configuration)' == 'Debug'">
-    <Message Text="Generating DSC resource JSON files to DSCv3 subfolder..." Importance="high" />
-    <MakeDir Directories="$(TargetDir)DSCv3" />
-    <Exec Command="dotnet &quot;$(TargetPath)&quot; manifest --resource settings --outputDir &quot;$(TargetDir)DSCv3&quot;" />
+  <!-- Generate the DSC resource JSON files to DSCModules subfolder -->
+  <!-- Skip generation in CI/CD builds (CIBuild=true) to avoid unnecessary work during pipeline -->
+  <Target Name="GenerateDscResourceJsonFiles" AfterTargets="Build" Condition="'$(CIBuild)' != 'true'">
+    <Message Text="Generating DSC resource JSON files to DSCModules subfolder..." Importance="high" />
+    <MakeDir Directories="$(TargetDir)DSCModules" />
+    <Exec Command="dotnet &quot;$(TargetPath)&quot; manifest --resource settings --outputDir &quot;$(TargetDir)DSCModules&quot;" />
  </Target>
 </Project>
--- a/tools/build/generate-dsc-manifests.ps1
+++ b/tools/build/generate-dsc-manifests.ps1
@@ -93,10 +93,10 @@ if (-not (Test-Path $outputDir)) {
    New-Item -Path $outputDir -ItemType Directory -Force | Out-Null
 }

-# DSC v3 manifests go to DSCv3 subfolder
-$dscOutputDir = Join-Path $outputDir 'DSCv3'
+# DSC v3 manifests go to DSCModules subfolder
+$dscOutputDir = Join-Path $outputDir 'DSCModules'
 if (-not (Test-Path $dscOutputDir)) {
-    Write-Host "Creating DSCv3 subfolder at '$dscOutputDir'."
+    Write-Host "Creating DSCModules subfolder at '$dscOutputDir'."
    New-Item -Path $dscOutputDir -ItemType Directory -Force | Out-Null
 }