cmdpal: use the unified Windows Terminal Versioning scheme (#39320)

This pull request adopts the unified versioning scheme used by Windows Terminal, Notepad, and hundreds of other internal and public projects that relied on "XES" or "PackageES". It only does so for the command palette. All command palette assets will be versioned according to the Major and Minor number in `src/modules/cmdpal/custom.props`. This includes DLLs, EXEs, NuGet packages and MSIX bundles. This will ensure that all artifacts that we produce are versioned properly: | thing | version (ex.) | |---------|-----------------| | dll/exe | 0.2.2505.08001 | | nupkg | 0.2.250508001 | | appx | 0.2.3269.0 | For reference, here's the version format: ### EXE, DLL, .NET Assembly 0.2.2505.08001 ^ ^ ^ ^ ^ ^ | | | | | `-Build # on that date | | | | `-Day | | | `-Month | | `-Year | `-Minor `-Major ### NuGet Package 0.2.250508001 ^ ^ ^ ^ ^ ^ | | | | | `-Build # on that date | | | | `-Day | | | `-Month | | `-Year | `-Minor `-Major ### AppX Package 0.2.01281.0 (the leading 0 will be removed) ^ ^ ^ ^^ ^ | | | || `-Contractually always zero (a waste) | | | |`-Build # on that date | | | `-Number of days in [base year] | | `-Number of years since [base year] | `-Minor `-Major [base year] = $(XesBaseYearForStoreVersion) It is expected that the base year is changed every time the version number is changed.
2026-04-03 17:56:44 +02:00 · 2025-05-14 12:15:19 -07:00
parent 469ffd93ea
commit a71cc282d3
28 changed files with 111 additions and 278 deletions
--- a/src/modules/cmdpal/CmdPalKeyboardService/CmdPalKeyboardService.rc
+++ b/src/modules/cmdpal/CmdPalKeyboardService/CmdPalKeyboardService.rc
@@ -1,40 +0,0 @@
-#include <windows.h>
-#include "resource.h"
-#include "../../../common/version/version.h"
-
-#define APSTUDIO_READONLY_SYMBOLS
-#include "winres.h"
-#undef APSTUDIO_READONLY_SYMBOLS
-
-1 VERSIONINFO
-FILEVERSION FILE_VERSION
-PRODUCTVERSION PRODUCT_VERSION
-FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
-#ifdef _DEBUG
-FILEFLAGS VS_FF_DEBUG
-#else
-FILEFLAGS 0x0L
-#endif
-FILEOS VOS_NT_WINDOWS32
-FILETYPE VFT_DLL
-FILESUBTYPE VFT2_UNKNOWN
-BEGIN
-    BLOCK "StringFileInfo"
-    BEGIN
-        BLOCK "040904b0" // US English (0x0409), Unicode (0x04B0) charset
-        BEGIN
-            VALUE "CompanyName", COMPANY_NAME
-            VALUE "FileDescription", FILE_DESCRIPTION
-            VALUE "FileVersion", FILE_VERSION_STRING
-            VALUE "InternalName", INTERNAL_NAME
-            VALUE "LegalCopyright", COPYRIGHT_NOTE
-            VALUE "OriginalFilename", ORIGINAL_FILENAME
-            VALUE "ProductName", PRODUCT_NAME
-            VALUE "ProductVersion", PRODUCT_VERSION_STRING
-        END
-    END
-    BLOCK "VarFileInfo"
-    BEGIN
-        VALUE "Translation", 0x409, 1200 // US English (0x0409), Unicode (1200) charset
-    END
-END
--- a/src/modules/cmdpal/CmdPalKeyboardService/CmdPalKeyboardService.vcxproj
+++ b/src/modules/cmdpal/CmdPalKeyboardService/CmdPalKeyboardService.vcxproj
@@ -108,7 +108,6 @@
    <ClInclude Include="KeyboardListener.h">
      <DependentUpon>KeyboardListener.idl</DependentUpon>
    </ClInclude>
-    <ClInclude Include="resource.h" />
  </ItemGroup>
  <ItemGroup>
    <ClCompile Include="pch.cpp">
@@ -130,9 +129,6 @@
    <None Include="PropertySheet.props" />
  </ItemGroup>

-  <ItemGroup>
-    <ResourceCompile Include="CmdPalKeyboardService.rc" />
-  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
  <Import Project="..\..\..\..\deps\spdlog.props" />
  <ImportGroup Label="ExtensionTargets">
--- a/src/modules/cmdpal/CmdPalKeyboardService/CmdPalKeyboardService.vcxproj.filters
+++ b/src/modules/cmdpal/CmdPalKeyboardService/CmdPalKeyboardService.vcxproj.filters
@@ -16,7 +16,6 @@
  </ItemGroup>
  <ItemGroup>
    <ClInclude Include="pch.h" />
-    <ClInclude Include="resource.h" />
  </ItemGroup>
  <ItemGroup>
    <Midl Include="KeyboardListener.idl" />
@@ -28,9 +27,4 @@
  <ItemGroup>
    <None Include="PropertySheet.props" />
  </ItemGroup>
-  <ItemGroup>
-    <ResourceCompile Include="CmdPalKeyboardService.rc">
-      <Filter>Resources</Filter>
-    </ResourceCompile>
-  </ItemGroup>
-</Project>
+</Project>
--- a/src/modules/cmdpal/CmdPalKeyboardService/resource.h
+++ b/src/modules/cmdpal/CmdPalKeyboardService/resource.h
@@ -1,13 +0,0 @@
-//{{NO_DEPENDENCIES}}
-// Microsoft Visual C++ generated include file.
-// Used by PowerToys.MeasureToolCore.rc
-
-//////////////////////////////
-// Non-localizable
-
-#define FILE_DESCRIPTION "CmdPalKeyboardService"
-#define INTERNAL_NAME "CmdPalKeyboardService"
-#define ORIGINAL_FILENAME "CmdPalKeyboardService.dll"
-
-// Non-localizable
-//////////////////////////////
--- a/src/modules/cmdpal/CmdPalModuleInterface/CmdPalModuleInterface.rc
+++ b/src/modules/cmdpal/CmdPalModuleInterface/CmdPalModuleInterface.rc
@@ -1,40 +0,0 @@
-#include <windows.h>
-#include "resource.h"
-#include "../../../common/version/version.h"
-
-#define APSTUDIO_READONLY_SYMBOLS
-#include "winres.h"
-#undef APSTUDIO_READONLY_SYMBOLS
-
-1 VERSIONINFO
-FILEVERSION FILE_VERSION
-PRODUCTVERSION PRODUCT_VERSION
-FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
-#ifdef _DEBUG
-FILEFLAGS VS_FF_DEBUG
-#else
-FILEFLAGS 0x0L
-#endif
-FILEOS VOS_NT_WINDOWS32
-FILETYPE VFT_DLL
-FILESUBTYPE VFT2_UNKNOWN
-BEGIN
-    BLOCK "StringFileInfo"
-    BEGIN
-        BLOCK "040904b0" // US English (0x0409), Unicode (0x04B0) charset
-        BEGIN
-            VALUE "CompanyName", COMPANY_NAME
-            VALUE "FileDescription", FILE_DESCRIPTION
-            VALUE "FileVersion", FILE_VERSION_STRING
-            VALUE "InternalName", INTERNAL_NAME
-            VALUE "LegalCopyright", COPYRIGHT_NOTE
-            VALUE "OriginalFilename", ORIGINAL_FILENAME
-            VALUE "ProductName", PRODUCT_NAME
-            VALUE "ProductVersion", PRODUCT_VERSION_STRING
-        END
-    END
-    BLOCK "VarFileInfo"
-    BEGIN
-        VALUE "Translation", 0x409, 1200 // US English (0x0409), Unicode (1200) charset
-    END
-END
--- a/src/modules/cmdpal/CmdPalModuleInterface/CmdPalModuleInterface.vcxproj
+++ b/src/modules/cmdpal/CmdPalModuleInterface/CmdPalModuleInterface.vcxproj
@@ -44,9 +44,6 @@
    <ProjectReference Include="..\..\..\common\SettingsAPI\SettingsAPI.vcxproj">
      <Project>{6955446d-23f7-4023-9bb3-8657f904af99}</Project>
    </ProjectReference>
-    <ProjectReference Include="..\..\..\common\version\version.vcxproj">
-      <Project>{cc6e41ac-8174-4e8a-8d22-85dd7f4851df}</Project>
-    </ProjectReference>
  </ItemGroup>
  <ItemDefinitionGroup>
    <ClCompile>
@@ -66,7 +63,6 @@

  <ItemGroup>
    <ClInclude Include="pch.h" />
-    <ClInclude Include="resource.h" />
  </ItemGroup>
  <ItemGroup>
    <ClCompile Include="dllmain.cpp" />
@@ -74,9 +70,6 @@
      <PrecompiledHeader>Create</PrecompiledHeader>
    </ClCompile>
  </ItemGroup>
-  <ItemGroup>
-    <ResourceCompile Include="CmdPalModuleInterface.rc" />
-  </ItemGroup>
  <ItemGroup>
    <None Include="packages.config" />
  </ItemGroup>
@@ -92,4 +85,4 @@
    <Error Condition="!Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props'))" />
    <Error Condition="!Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets'))" />
  </Target>
-</Project>
+</Project>
--- a/src/modules/cmdpal/CmdPalModuleInterface/resource.h
+++ b/src/modules/cmdpal/CmdPalModuleInterface/resource.h
@@ -1,13 +0,0 @@
-//{{NO_DEPENDENCIES}}
-// Microsoft Visual C++ generated include file.
-// Used by AlwaysOnTopModuleInterface.rc
-
-//////////////////////////////
-// Non-localizable
-
-#define FILE_DESCRIPTION "PowerToys Command Palette Module"
-#define INTERNAL_NAME "PowerToys.CmdPalModuleInterface"
-#define ORIGINAL_FILENAME "PowerToys.CmdPalModuleInterface.dll"
-
-// Non-localizable
-//////////////////////////////
--- a/src/modules/cmdpal/Microsoft.CmdPal.UI/CmdPal.pre.props
+++ b/src/modules/cmdpal/Microsoft.CmdPal.UI/CmdPal.pre.props
@@ -8,6 +8,8 @@

  <PropertyGroup>
    <OutputPath>$(SolutionDir)$(Platform)\$(Configuration)\WinUI3Apps\CmdPal</OutputPath>
+    <!-- Reset this because the Versioning task might have overwritten it before it knew about OutDir -->
+    <AppxPackageDir>$(OutputPath)\AppPackages\</AppxPackageDir>
  </PropertyGroup>

 </Project>
--- a/src/modules/cmdpal/Microsoft.CmdPal.UI/Microsoft.CmdPal.UI.csproj
+++ b/src/modules/cmdpal/Microsoft.CmdPal.UI/Microsoft.CmdPal.UI.csproj
@@ -38,6 +38,18 @@
    <DefineConstants>DISABLE_XAML_GENERATED_MAIN</DefineConstants>
  </PropertyGroup>

+  <!-- BODGY: XES Versioning and WinAppSDK get into a fight about the app manifest, which breaks WinAppSDK. -->
+  <Target Name="RearrangeXefVersioningAndWinAppSDKResourceGeneration"
+          DependsOnTargets="GetNewAppManifestValues;CreateWinRTRegistration"
+          BeforeTargets="XesWriteVersionInfoResourceFile">
+    <PropertyGroup>
+      <!-- XES uses this property to store the "final" location of the app manifest, before it erases it.
+           We have to update it to the value WinAppSDK set it to. -->
+      <OriginalApplicationManifest>$(ApplicationManifest.Replace("$(MSBuildProjectDirectory)\",""))</OriginalApplicationManifest>
+    </PropertyGroup>
+    <Message Importance="High" Text="Updated final manifest path to $(OriginalApplicationManifest)" />
+  </Target>
+
  <ItemGroup>
    <None Remove="Controls\ActionBar.xaml" />
    <None Remove="Controls\SearchBar.xaml" />
--- a/src/modules/cmdpal/Microsoft.Terminal.UI/Microsoft.Terminal.UI.vcxproj
+++ b/src/modules/cmdpal/Microsoft.Terminal.UI/Microsoft.Terminal.UI.vcxproj
@@ -23,9 +23,6 @@
    <WindowsTargetPlatformMinVersion>10.0.19041.0</WindowsTargetPlatformMinVersion>
  </PropertyGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
-  <ItemGroup>
-    <ResourceCompile Include="version.rc" />
-  </ItemGroup>
  <ItemGroup Label="ProjectConfigurations">
    <ProjectConfiguration Include="Debug|ARM64">
      <Configuration>Debug</Configuration>
@@ -156,7 +153,6 @@
    <ClInclude Include="IconPathConverter.h">
      <DependentUpon>IconPathConverter.idl</DependentUpon>
    </ClInclude>
-    <ClInclude Include="resource.h" />
    <ClInclude Include="ResourceString.h">
      <DependentUpon>ResourceString.idl</DependentUpon>
    </ClInclude>
@@ -205,9 +201,4 @@
    <Error Condition="!Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.props'))" />
    <Error Condition="!Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.240111.5\build\native\Microsoft.Windows.CppWinRT.targets'))" />
  </Target>
-  <ItemGroup>
-    <ProjectReference Include="..\..\..\common\version\version.vcxproj">
-      <Project>{cc6e41ac-8174-4e8a-8d22-85dd7f4851df}</Project>
-    </ProjectReference>
-  </ItemGroup>
-</Project>
+</Project>
--- a/src/modules/cmdpal/Microsoft.Terminal.UI/resource.h
+++ b/src/modules/cmdpal/Microsoft.Terminal.UI/resource.h
@@ -1,13 +0,0 @@
-//{{NO_DEPENDENCIES}}
-// Microsoft Visual C++ generated include file.
-// Used by AlwaysOnTopModuleInterface.rc
-
-//////////////////////////////
-// Non-localizable
-
-#define FILE_DESCRIPTION "PowerToys Command Palette Terminal UI"
-#define INTERNAL_NAME "Microsoft.Terminal.UI"
-#define ORIGINAL_FILENAME "Microsoft.Terminal.UI.dll"
-
-// Non-localizable
-//////////////////////////////
--- a/src/modules/cmdpal/Microsoft.Terminal.UI/version.rc
+++ b/src/modules/cmdpal/Microsoft.Terminal.UI/version.rc
@@ -1,40 +0,0 @@
-#include <windows.h>
-#include "resource.h"
-#include "../../../../common/version/version.h"
-
-#define APSTUDIO_READONLY_SYMBOLS
-#include "winres.h"
-#undef APSTUDIO_READONLY_SYMBOLS
-
-1 VERSIONINFO
-FILEVERSION FILE_VERSION
-PRODUCTVERSION PRODUCT_VERSION
-FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
-#ifdef _DEBUG
-FILEFLAGS VS_FF_DEBUG
-#else
-FILEFLAGS 0x0L
-#endif
-FILEOS VOS_NT_WINDOWS32
-FILETYPE VFT_DLL
-FILESUBTYPE VFT2_UNKNOWN
-BEGIN
-    BLOCK "StringFileInfo"
-    BEGIN
-        BLOCK "040904b0" // US English (0x0409), Unicode (0x04B0) charset
-        BEGIN
-            VALUE "CompanyName", COMPANY_NAME
-            VALUE "FileDescription", FILE_DESCRIPTION
-            VALUE "FileVersion", FILE_VERSION_STRING
-            VALUE "InternalName", INTERNAL_NAME
-            VALUE "LegalCopyright", COPYRIGHT_NOTE
-            VALUE "OriginalFilename", ORIGINAL_FILENAME
-            VALUE "ProductName", PRODUCT_NAME
-            VALUE "ProductVersion", PRODUCT_VERSION_STRING
-        END
-    END
-    BLOCK "VarFileInfo"
-    BEGIN
-        VALUE "Translation", 0x409, 1200 // US English (0x0409), Unicode (1200) charset
-    END
-END
--- a/src/modules/cmdpal/custom.props
+++ b/src/modules/cmdpal/custom.props
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!-- This file is read by XES, which we use in our Release builds. -->
+  <PropertyGroup Label="Version">
+    <XesUseOneStoreVersioning>true</XesUseOneStoreVersioning>
+    <XesBaseYearForStoreVersion>2025</XesBaseYearForStoreVersion>
+    <VersionMajor>0</VersionMajor>
+    <VersionMinor>2</VersionMinor>
+    <VersionInfoProductName>Microsoft Command Palette</VersionInfoProductName>
+  </PropertyGroup>
+</Project>
--- a/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/Microsoft.CommandPalette.Extensions.Toolkit.csproj
+++ b/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions.Toolkit/Microsoft.CommandPalette.Extensions.Toolkit.csproj
@@ -51,6 +51,6 @@
    <PublishAot>True</PublishAot>

    <!-- Suppress DynamicallyAccessedMemberTypes.PublicParameterlessConstructor in fallback code path of Windows SDK projection -->
-    <WarningsNotAsErrors>IL2081</WarningsNotAsErrors>
+    <WarningsNotAsErrors>IL2081;$(WarningsNotAsErrors)</WarningsNotAsErrors>
  </PropertyGroup>
 </Project>
--- a/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions/Microsoft.CommandPalette.Extensions.vcxproj
+++ b/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions/Microsoft.CommandPalette.Extensions.vcxproj
@@ -180,12 +180,4 @@
    <Error Condition="!Exists('$(WasdkNuget)\build\native\Microsoft.WindowsAppSDK.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(WasdkNuget)\build\native\Microsoft.WindowsAppSDK.targets'))" />
    <Error Condition="!Exists('$(WebView2Nuget)\build\native\Microsoft.Web.WebView2.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(WebView2Nuget)\build\native\Microsoft.Web.WebView2.targets'))" />
  </Target>
-  <ItemGroup>
-    <ResourceCompile Include="version.rc" />
-  </ItemGroup>
-  <ItemGroup>
-    <ProjectReference Include="..\..\..\..\common\version\version.vcxproj">
-      <Project>{cc6e41ac-8174-4e8a-8d22-85dd7f4851df}</Project>
-    </ProjectReference>
-  </ItemGroup>
 </Project>
--- a/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions/version.rc
+++ b/src/modules/cmdpal/extensionsdk/Microsoft.CommandPalette.Extensions/version.rc
@@ -1,34 +0,0 @@
-#include "winres.h"
-
-#include "../../../../common/version/version.h"
-
-VS_VERSION_INFO VERSIONINFO
- FILEVERSION FILE_VERSION
- PRODUCTVERSION PRODUCT_VERSION
- FILEFLAGSMASK 0x3fL
-#ifdef _DEBUG
- FILEFLAGS 0x1L
-#else
- FILEFLAGS 0x0L
-#endif
- FILEOS 0x40004L
- FILETYPE 0x0L
- FILESUBTYPE 0x0L
-BEGIN
-    BLOCK "StringFileInfo"
-    BEGIN
-        BLOCK "040904b0"
-        BEGIN
-            VALUE "CompanyName", "Microsoft Corporation"
-            VALUE "FileDescription", "Microsoft.CommandPalette.Extensions.Toolkit"
-            VALUE "FileVersion", FILE_VERSION_STRING
-            VALUE "ProductName", "Microsoft.CommandPalette.Extensions.Toolkit"
-            VALUE "ProductVersion", PRODUCT_VERSION_STRING
-            VALUE "LegalCopyright", "Copyright (c) Microsoft Corporation"
-        END
-    END
-    BLOCK "VarFileInfo"
-    BEGIN
-        VALUE "Translation", 0x409, 1200
-    END
-END
--- a/src/modules/cmdpal/extensionsdk/nuget/BuildSDKHelper.ps1
+++ b/src/modules/cmdpal/extensionsdk/nuget/BuildSDKHelper.ps1
@@ -1,11 +1,19 @@
 Param(
  [string]$Configuration = "release",
-  [string]$VersionOfSDK = "0.0.0",
+  [string]$VersionOfSDK = "",
  [string]$BuildStep = "all",
  [switch]$IsAzurePipelineBuild = $false,
  [switch]$Help = $false
 )

+If ([String]::IsNullOrEmpty($VersionOfSDK)) {
+  $VersionOfSDK = $Env:XES_PACKAGEVERSIONNUMBER
+}
+
+If ([String]::IsNullOrEmpty($VersionOfSDK)) {
+  $VersionOfSDK = "0.0.0"
+}
+
 $StartTime = Get-Date

 if ($Help) {