Compare commits

...

8 Commits

Author SHA1 Message Date
Jessica Dene Earley-Cha
a0f35c4dac Merge branch 'main' into template-automation 2025-12-18 13:42:27 -08:00
chatasweetie
1fc14a2d95 Update check-spelling metadata 2025-12-18 13:38:22 -08:00
chatasweetie
437211b0e9 Merge branch 'template-automation' of https://github.com/microsoft/PowerToys into template-automation 2025-11-19 09:51:42 -08:00
chatasweetie
ca211be443 correct typo of pubishing and removed my from myextension 2025-11-19 09:43:08 -08:00
chatasweetie
066c3247ed correct typo of pubishing and removed my from myextension 2025-11-18 16:06:45 -08:00
chatasweetie
e87d1fefe6 add Publication scripts for Microsoft Store and WinGet template 2025-11-17 15:09:38 -08:00
chatasweetie
e6d541ad7a add configuration for microsoft store and msix building to template 2025-11-17 15:07:32 -08:00
chatasweetie
a0a6f990e9 update template for publish items in appxmanifest & .csproj 2025-11-17 15:04:26 -08:00
11 changed files with 2385 additions and 13 deletions

View File

@@ -111,6 +111,7 @@ AUTORADIOBUTTON
Autorun
AUTOTICKS
AUTOUPDATE
autopf
AValid
AWAYMODE
azcliversion
@@ -267,6 +268,8 @@ CONFIGW
CONFLICTINGMODIFIERKEY
CONFLICTINGMODIFIERSHORTCUT
CONOUT
Contoso
coreclr
constexpr
contentdialog
contentfiles
@@ -751,6 +754,7 @@ IFACEMETHOD
IFACEMETHODIMP
ifd
IGNOREUNKNOWN
ignoreversion
IGo
iid
IIM
@@ -777,6 +781,7 @@ INITDIALOG
INITGUID
INITTOLOGFONTSTRUCT
INLINEPREFIX
Inno
inlines
Inno
INPC
@@ -811,6 +816,7 @@ IPTC
irow
irprops
isbi
iscc
isfinite
iss
issecret
@@ -1443,6 +1449,7 @@ RECTDESTINATION
rectp
RECTSOURCE
recyclebin
recursesubdirs
Redist
Reencode
REFCLSID
@@ -1794,6 +1801,7 @@ TILEDWINDOW
TILLSON
timedate
timediff
timestamped
timeunion
timeutil
TITLEBARINFO

View File

@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<Package
xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
@@ -8,13 +8,19 @@
xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
IgnorableNamespaces="uap uap3 rescap">
<!-- FOR PUBLISHING TO MICROSOFT STORE -->
<!-- When you're ready to publish your extension to Microsoft Store,you'll need to
change the values in the Identity & Properties tags below
Name = replace with Microsoft Store's Package/Identity/Name
Publisher = replace with Microsoft Store's Package/Identity/Publisher
DisplayName = replace with the reserved name from Partner Center
PublisherDisplayName = replace with Microsoft Store's Package/Properties/PublisherDisplayName
Logo = Confirm that this image exist at the path
-->
<Identity
Name="TemplateCmdPalExtension"
Publisher="CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US"
Version="0.0.1.0" />
<!-- When you're ready to publish your extension, you'll need to change the
Publisher= to match your own identity -->
<Properties>
<DisplayName>TemplateDisplayName</DisplayName>
<PublisherDisplayName>A Lone Developer</PublisherDisplayName>

View File

@@ -0,0 +1,129 @@
# Publication Setup
This folder contains tools to help you prepare your CmdPal extension for publication to the Microsoft Store and WinGet.
## Files and Folders in this Directory
### Scripts
- **`one-time-store-publishing-setup.ps1`** - Configure your project for Microsoft Store publishing (run once)
- **`build-msix-bundles.ps1`** - Build MSIX packages and create bundles for Store submission
- **`one-time-winget-publishing-setup.ps1`** - Configure your project for WinGet publishing (run once)
### Resource Folders
- **`microsoft-store-resources/`** - Contains files used for Microsoft Store publishing:
- `bundle_mapping.txt` - Auto-generated file that maps MSIX files for bundle creation
- **`winget-resources/`** - Contains templates and scripts for WinGet publishing:
- `build-exe.ps1` - Script to build standalone EXE installer
- `setup-template.iss` - Inno Setup installer template
- `release-extension.yml` - GitHub Actions workflow template (moved to `.github/workflows/` during setup)
- `Backups/` - Backup copies of configuration files (created during setup)
## Microsoft Store Quick Start
1. Open PowerShell and navigate to the Publication folder:
```powershell
cd <YourProject>\Publication
```
2. Run the one-time setup script:
```powershell
.\one-time-store-publishing-setup.ps1
```
3. Follow the prompts to enter your Microsoft Store information from Partner Center:
- Package Identity Name
- Publisher Certificate
- Display Name
- Publisher Display Name
The script will update your `Package.appxmanifest` with Store-specific values.
4. Once configured, build your bundle:
```powershell
.\build-msix-bundles.ps1
```
This script will:
- Build x64 and ARM64 MSIX packages
- Automatically update `microsoft-store-resources\bundle_mapping.txt` with correct paths
- Create a combined MSIX bundle
- Display the bundle location when complete
5. Upload the resulting `.msixbundle` file from `microsoft-store-resources\` to Partner Center
## Troubleshooting
### makeappx.exe not found
The build script requires the Windows SDK. Install it via:
- Visual Studio Installer (Individual Components → Windows SDK)
- [Standalone Windows SDK](https://developer.microsoft.com/windows/downloads/windows-sdk/)
### Build errors
Ensure you have:
- .NET 9.0 SDK installed
- Windows SDK 10.0.26100.0 or compatible version
- No other instances of Visual Studio building the project
### Bundle creation fails
Check that:
- Both x64 and ARM64 builds completed successfully
- `microsoft-store-resources\bundle_mapping.txt` paths are correct (auto-updated by script)
- No file locks on the MSIX files
## WinGet Quick Start
1. Open PowerShell and navigate to the Publication folder:
```powershell
cd <YourProject>\Publication
```
2. Run the one-time setup script:
```powershell
.\one-time-winget-publishing-setup.ps1
```
3. Follow the prompts to enter:
- GitHub Repository URL (where releases will be published)
- Developer/Publisher Name
The script will:
- Configure `winget-resources\build-exe.ps1` with your extension details
- Configure `winget-resources\setup-template.iss` with your extension information
- Move `release-extension.yml` to `.github\workflows\` in your repository root
4. Commit and push changes to GitHub:
```powershell
git add .
git commit -m "Configure extension for WinGet publishing"
git push
```
5. Trigger the GitHub Action to build and release:
```powershell
gh workflow run release-extension.yml --ref main -f "release_notes=**First Release of <ExtensionName> Extension for Command Palette**
The inaugural release of the <ExtensionName> for Command Palette..."
```
Or create a release manually through the GitHub web interface.
## Additional Resources
- [Command Palette Extension Publishing Documentation](https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension)
- [Microsoft Store Publishing Guide](https://learn.microsoft.com/windows/apps/publish/)

View File

@@ -0,0 +1,570 @@
# Build MSIX Bundles Script for CmdPal Extension
# This script automates the process of building MSIX packages for x64 and ARM64 architectures
# and creating an MSIX bundle for distribution
# Version: 1.0
#Requires -Version 5.1
# Enable strict mode for better error detection
Set-StrictMode -Version Latest
$ErrorActionPreference = "Stop"
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " CmdPal Extension MSIX Builder" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
# Determine project root (parent of Publication folder)
$projectRoot = Split-Path -Parent $PSScriptRoot
$projectName = Split-Path -Leaf $projectRoot
Write-Host "Project Configuration:" -ForegroundColor Yellow
Write-Host " Project Root: $projectRoot" -ForegroundColor Gray
Write-Host " Project Name: $projectName" -ForegroundColor Gray
Write-Host ""
# Verify we're in the right location
$csprojPath = Join-Path $projectRoot "$projectName.csproj"
$manifestPath = Join-Path $projectRoot "Package.appxmanifest"
if (-not (Test-Path $csprojPath)) {
Write-Host "ERROR: Could not find .csproj file at: $csprojPath" -ForegroundColor Red
Write-Host ""
Write-Host "This script must be run from the Publication folder within your project." -ForegroundColor Yellow
Write-Host "Expected structure:" -ForegroundColor Gray
Write-Host " <ProjectRoot>\" -ForegroundColor Gray
Write-Host " <ProjectName>.csproj" -ForegroundColor Gray
Write-Host " Publication\" -ForegroundColor Gray
Write-Host " build-msix-bundles.ps1 (this script)" -ForegroundColor Gray
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not (Test-Path $manifestPath)) {
Write-Host "ERROR: Could not find Package.appxmanifest at: $manifestPath" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [OK] Project files validated" -ForegroundColor Green
Write-Host ""
# Extract version from Package.appxmanifest
Write-Host "Reading package information..." -ForegroundColor Cyan
try {
[xml]$manifest = Get-Content $manifestPath -ErrorAction Stop
$packageName = $manifest.Package.Identity.Name
$packageVersion = $manifest.Package.Identity.Version
Write-Host " Package Name: $packageName" -ForegroundColor White
Write-Host " Version: $packageVersion" -ForegroundColor White
Write-Host ""
}
catch {
Write-Host "ERROR: Could not read Package.appxmanifest: $($_.Exception.Message)" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
# Ask user what to build
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Build Options" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "What would you like to build?" -ForegroundColor Yellow
Write-Host ""
Write-Host " [1] x64 MSIX only" -ForegroundColor White
Write-Host " [2] ARM64 MSIX only" -ForegroundColor White
Write-Host " [3] Complete Bundle (x64 + ARM64 + Bundle file)" -ForegroundColor White
Write-Host ""
Write-Host "Enter your choice (1-3): " -ForegroundColor Yellow -NoNewline
$buildChoice = Read-Host
Write-Host ""
# Validate choice
if ($buildChoice -notmatch '^[1-3]$') {
Write-Host "ERROR: Invalid choice. Please enter 1, 2, or 3." -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
# Determine what to build
$buildX64 = $false
$buildARM64 = $false
$createBundle = $false
switch ($buildChoice) {
"1" {
$buildX64 = $true
Write-Host "Building: x64 MSIX only" -ForegroundColor Cyan
}
"2" {
$buildARM64 = $true
Write-Host "Building: ARM64 MSIX only" -ForegroundColor Cyan
}
"3" {
$buildX64 = $true
$buildARM64 = $true
$createBundle = $true
Write-Host "Building: Complete Bundle (x64 + ARM64 + Bundle)" -ForegroundColor Cyan
}
}
Write-Host ""
# Clean previous builds (optional)
Write-Host "Do you want to clean previous builds? (Y/N): " -ForegroundColor Yellow -NoNewline
$cleanBuilds = Read-Host
if ($cleanBuilds -match '^[Yy]') {
Write-Host ""
Write-Host "Cleaning previous builds..." -ForegroundColor Cyan
$appPackagesPath = Join-Path $projectRoot "AppPackages"
if (Test-Path $appPackagesPath) {
try {
Remove-Item $appPackagesPath -Recurse -Force -ErrorAction Stop
Write-Host " [OK] Cleaned AppPackages folder" -ForegroundColor Green
}
catch {
Write-Host " [WARNING] Could not clean AppPackages: $($_.Exception.Message)" -ForegroundColor Yellow
}
}
# Clean old bundles in microsoft-store-resources folder
$microsoftStoreResourcesPath = Join-Path $PSScriptRoot "microsoft-store-resources"
if (Test-Path $microsoftStoreResourcesPath) {
$oldBundles = Get-ChildItem $microsoftStoreResourcesPath -Filter "*.msixbundle" -ErrorAction SilentlyContinue
if ($oldBundles) {
foreach ($bundle in $oldBundles) {
try {
Remove-Item $bundle.FullName -Force -ErrorAction Stop
Write-Host " [OK] Removed old bundle: $($bundle.Name)" -ForegroundColor Green
}
catch {
Write-Host " [WARNING] Could not remove $($bundle.Name): $($_.Exception.Message)" -ForegroundColor Yellow
}
}
}
}
Write-Host ""
}
else {
Write-Host ""
}
# Track built files for summary
$builtFiles = @()
$x64Msix = $null
$arm64Msix = $null
# Build x64 MSIX (if requested)
if ($buildX64) {
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Building x64 MSIX Package" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Running: dotnet build (x64)..." -ForegroundColor Yellow
Write-Host "This may take a few seconds" -ForegroundColor Yellow
Write-Host ""
Push-Location $projectRoot
try {
$buildOutput = & dotnet build --configuration Release -p:GenerateAppxPackageOnBuild=true -p:Platform=x64 -p:AppxPackageDir="AppPackages\x64\" 2>&1
if ($LASTEXITCODE -ne 0) {
Write-Host ""
Write-Host "ERROR: x64 build failed with exit code $LASTEXITCODE" -ForegroundColor Red
Write-Host ""
Write-Host "Build output:" -ForegroundColor Gray
$buildOutput | ForEach-Object { Write-Host " $_" -ForegroundColor Gray }
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
Pop-Location
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [SUCCESS] x64 build completed" -ForegroundColor Green
Write-Host ""
}
catch {
Write-Host ""
Write-Host "ERROR: x64 build failed: $($_.Exception.Message)" -ForegroundColor Red
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
finally {
Pop-Location
}
}
# Build ARM64 MSIX (if requested)
if ($buildARM64) {
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Building ARM64 MSIX Package" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Running: dotnet build (ARM64)..." -ForegroundColor Yellow
Write-Host "This may take a few seconds" -ForegroundColor Yellow
Write-Host ""
Push-Location $projectRoot
try {
$buildOutput = & dotnet build --configuration Release -p:GenerateAppxPackageOnBuild=true -p:Platform=ARM64 -p:AppxPackageDir="AppPackages\ARM64\" 2>&1
if ($LASTEXITCODE -ne 0) {
Write-Host ""
Write-Host "ERROR: ARM64 build failed with exit code $LASTEXITCODE" -ForegroundColor Red
Write-Host ""
Write-Host "Build output:" -ForegroundColor Gray
$buildOutput | ForEach-Object { Write-Host " $_" -ForegroundColor Gray }
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
Pop-Location
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [SUCCESS] ARM64 build completed" -ForegroundColor Green
Write-Host ""
}
catch {
Write-Host ""
Write-Host "ERROR: ARM64 build failed: $($_.Exception.Message)" -ForegroundColor Red
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
finally {
Pop-Location
}
}
# Locate MSIX files (if bundle creation is needed or for summary)
if ($createBundle -or $buildX64 -or $buildARM64) {
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Locating MSIX Files" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Push-Location $projectRoot
try {
$msixFiles = Get-ChildItem "AppPackages" -Recurse -Filter "*.msix" -ErrorAction SilentlyContinue
if (-not $msixFiles) {
# Try alternate location
Write-Host " MSIX files not found in AppPackages, checking bin folder..." -ForegroundColor Yellow
$msixFiles = Get-ChildItem "bin" -Recurse -Filter "*.msix" -ErrorAction SilentlyContinue
}
if ($buildX64 -and $buildARM64 -and $createBundle -and (-not $msixFiles -or $msixFiles.Count -lt 2)) {
Write-Host "ERROR: Could not find both x64 and ARM64 MSIX files" -ForegroundColor Red
Write-Host ""
Write-Host "Expected files:" -ForegroundColor Gray
Write-Host " - ${packageName}_${packageVersion}_x64.msix" -ForegroundColor Gray
Write-Host " - ${packageName}_${packageVersion}_arm64.msix" -ForegroundColor Gray
Write-Host ""
if ($msixFiles) {
Write-Host "Found files:" -ForegroundColor Yellow
$msixFiles | ForEach-Object { Write-Host " - $($_.FullName)" -ForegroundColor Gray }
Write-Host ""
}
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if ($msixFiles) {
Write-Host " Found MSIX files:" -ForegroundColor Green
$msixFiles | ForEach-Object {
$relativePath = $_.FullName -replace [regex]::Escape($projectRoot + "\"), ""
Write-Host " [OK] $relativePath" -ForegroundColor White
}
Write-Host ""
}
# Find specific x64 and ARM64 files
if ($buildX64) {
$x64Msix = $msixFiles | Where-Object { $_.Name -match "_x64\.msix$" } | Select-Object -First 1
if ($x64Msix) {
$builtFiles += $x64Msix.FullName
}
}
if ($buildARM64) {
$arm64Msix = $msixFiles | Where-Object { $_.Name -match "_arm64\.msix$" } | Select-Object -First 1
if ($arm64Msix) {
$builtFiles += $arm64Msix.FullName
}
}
# Validate files for bundle creation
if ($createBundle) {
if (-not $x64Msix) {
Write-Host "ERROR: Could not find x64 MSIX file" -ForegroundColor Red
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not $arm64Msix) {
Write-Host "ERROR: Could not find ARM64 MSIX file" -ForegroundColor Red
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
}
}
finally {
Pop-Location
}
}
# Create bundle (if requested)
if ($createBundle) {
# Update bundle_mapping.txt
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Updating bundle_mapping.txt" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
$microsoftStoreResourcesPath = Join-Path $PSScriptRoot "microsoft-store-resources"
$bundleMappingPath = Join-Path $microsoftStoreResourcesPath "bundle_mapping.txt"
# Ensure microsoft-store-resources directory exists
if (-not (Test-Path $microsoftStoreResourcesPath)) {
Write-Host " Creating microsoft-store-resources folder..." -ForegroundColor Yellow
try {
New-Item -Path $microsoftStoreResourcesPath -ItemType Directory -Force | Out-Null
Write-Host " [OK] Folder created" -ForegroundColor Green
}
catch {
Write-Host " [ERROR] Could not create folder: $($_.Exception.Message)" -ForegroundColor Red
}
}
# Get relative paths from project root
$x64RelativePath = $x64Msix.FullName -replace [regex]::Escape($projectRoot + "\"), ""
$arm64RelativePath = $arm64Msix.FullName -replace [regex]::Escape($projectRoot + "\"), ""
# Create bundle mapping content
$line1 = "`"$x64RelativePath`" `"$($x64Msix.Name)`""
$line2 = "`"$arm64RelativePath`" `"$($arm64Msix.Name)`""
$bundleMappingContent = "[Files]`r`n$line1`r`n$line2"
try {
Set-Content -Path $bundleMappingPath -Value $bundleMappingContent -NoNewline -ErrorAction Stop
Write-Host " [SUCCESS] bundle_mapping.txt updated" -ForegroundColor Green
Write-Host ""
Write-Host " Content:" -ForegroundColor Gray
Write-Host " [Files]" -ForegroundColor DarkGray
Write-Host (' "' + $x64RelativePath + '" "' + $x64Msix.Name + '"') -ForegroundColor DarkGray
Write-Host (' "' + $arm64RelativePath + '" "' + $arm64Msix.Name + '"') -ForegroundColor DarkGray
Write-Host ""
}
catch {
Write-Host " [ERROR] Could not update bundle_mapping.txt: $($_.Exception.Message)" -ForegroundColor Red
Write-Host " Continuing with bundle creation..." -ForegroundColor Yellow
Write-Host ""
}
# Find makeappx.exe
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Creating MSIX Bundle" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Locating makeappx.exe..." -ForegroundColor Yellow
$arch = switch ($env:PROCESSOR_ARCHITECTURE) {
"AMD64" { "x64" }
"x86" { "x86" }
"ARM64" { "arm64" }
default { "x64" }
}
Write-Host " Detected architecture: $arch" -ForegroundColor Gray
$makeappxPath = Get-ChildItem "C:\Program Files (x86)\Windows Kits\10\bin\*\$arch\makeappx.exe" -ErrorAction SilentlyContinue |
Sort-Object Name -Descending |
Select-Object -First 1
if (-not $makeappxPath) {
Write-Host ""
Write-Host "ERROR: makeappx.exe not found" -ForegroundColor Red
Write-Host ""
Write-Host "makeappx.exe is part of the Windows SDK." -ForegroundColor Yellow
Write-Host "Please install the Windows SDK from:" -ForegroundColor Yellow
Write-Host " https://developer.microsoft.com/windows/downloads/windows-sdk/" -ForegroundColor Cyan
Write-Host ""
Write-Host "Or ensure the Windows SDK is installed with Visual Studio." -ForegroundColor Yellow
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [OK] Found: $($makeappxPath.FullName)" -ForegroundColor Green
Write-Host ""
# Create bundle
$bundleFileName = "${packageName}_${packageVersion}_Bundle.msixbundle"
$bundleOutputPath = Join-Path $microsoftStoreResourcesPath $bundleFileName
Write-Host "Creating bundle: $bundleFileName" -ForegroundColor Yellow
Write-Host ""
Push-Location $projectRoot
try {
# Use absolute path to bundle_mapping.txt
$bundleMappingAbsolute = Join-Path $microsoftStoreResourcesPath "bundle_mapping.txt"
# Verify the mapping file exists
if (-not (Test-Path $bundleMappingAbsolute)) {
Write-Host "ERROR: bundle_mapping.txt not found at: $bundleMappingAbsolute" -ForegroundColor Red
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
$makeappxArgs = @(
"bundle",
"/v",
"/f", "`"$bundleMappingAbsolute`"",
"/p", "`"$bundleOutputPath`""
)
Write-Host " Running: makeappx bundle /v /f `"$bundleMappingAbsolute`" /p `"$bundleOutputPath`"" -ForegroundColor Gray
Write-Host ""
# Run makeappx with proper quoting
$bundleOutput = & $makeappxPath.FullName bundle /v /f $bundleMappingAbsolute /p $bundleOutputPath 2>&1
if ($LASTEXITCODE -ne 0) {
Write-Host ""
Write-Host "ERROR: Bundle creation failed with exit code $LASTEXITCODE" -ForegroundColor Red
Write-Host ""
Write-Host "Output:" -ForegroundColor Gray
$bundleOutput | ForEach-Object { Write-Host " $_" -ForegroundColor Gray }
Write-Host ""
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [SUCCESS] Bundle created" -ForegroundColor Green
Write-Host ""
}
catch {
Write-Host ""
Write-Host "ERROR: Bundle creation failed: $($_.Exception.Message)" -ForegroundColor Red
Pop-Location
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
finally {
Pop-Location
}
# Verify bundle was created
if (-not (Test-Path $bundleOutputPath)) {
Write-Host "ERROR: Bundle file was not created at expected location" -ForegroundColor Red
Write-Host " Expected: $bundleOutputPath" -ForegroundColor Gray
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
# Add bundle to built files
$builtFiles += $bundleOutputPath
}
# Final Summary
Write-Host "================================================================" -ForegroundColor Green
Write-Host " BUILD COMPLETED SUCCESSFULLY!" -ForegroundColor Green
Write-Host "================================================================" -ForegroundColor Green
Write-Host ""
# Display what was built
if ($buildChoice -eq "1") {
Write-Host "Built: x64 MSIX Package" -ForegroundColor Cyan
}
elseif ($buildChoice -eq "2") {
Write-Host "Built: ARM64 MSIX Package" -ForegroundColor Cyan
}
elseif ($buildChoice -eq "3") {
Write-Host "Built: Complete Bundle (x64 + ARM64 + Bundle file)" -ForegroundColor Cyan
}
Write-Host ""
Write-Host "Package Information:" -ForegroundColor Yellow
Write-Host " Name: $packageName" -ForegroundColor White
Write-Host " Version: $packageVersion" -ForegroundColor White
Write-Host ""
# Display built files
Write-Host "Built Files:" -ForegroundColor Yellow
if ($x64Msix) {
$x64Size = "{0:N2} MB" -f ((Get-Item $x64Msix.FullName).Length / 1MB)
Write-Host " [x64 MSIX]" -ForegroundColor Cyan
Write-Host " Location: $($x64Msix.FullName)" -ForegroundColor White
Write-Host " Size: $x64Size" -ForegroundColor White
Write-Host ""
}
if ($arm64Msix) {
$arm64Size = "{0:N2} MB" -f ((Get-Item $arm64Msix.FullName).Length / 1MB)
Write-Host " [ARM64 MSIX]" -ForegroundColor Cyan
Write-Host " Location: $($arm64Msix.FullName)" -ForegroundColor White
Write-Host " Size: $arm64Size" -ForegroundColor White
Write-Host ""
}
if ($createBundle -and (Test-Path $bundleOutputPath)) {
$bundleSize = "{0:N2} MB" -f ((Get-Item $bundleOutputPath).Length / 1MB)
Write-Host " [MSIX Bundle]" -ForegroundColor Cyan
Write-Host " Location: $bundleOutputPath" -ForegroundColor White
Write-Host " Size: $bundleSize" -ForegroundColor White
Write-Host ""
}
Write-Host "================================================================" -ForegroundColor Green
Write-Host ""
# Display appropriate next steps based on what was built
Write-Host "Next Steps:" -ForegroundColor Cyan
if ($createBundle) {
Write-Host " 1. Test the bundle by installing it locally" -ForegroundColor Gray
Write-Host " 2. Upload the bundle to Microsoft Store Partner Center" -ForegroundColor Gray
Write-Host " 3. Or distribute via other channels" -ForegroundColor Gray
}
else {
Write-Host " 1. Test the MSIX package by installing it locally" -ForegroundColor Gray
if ($buildX64) {
Write-Host " 2. Build ARM64 package (option 2) or complete bundle (option 3)" -ForegroundColor Gray
}
else {
Write-Host " 2. Build x64 package (option 1) or complete bundle (option 3)" -ForegroundColor Gray
}
Write-Host " 3. Or distribute this individual package" -ForegroundColor Gray
}
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")

View File

@@ -0,0 +1,3 @@
[Files]
"AppPackages\x64\TemplateCmdPalExtension_0.0.1.0_x64_Test\TemplateCmdPalExtension_0.0.1.0_x64.msix" "TemplateCmdPalExtension_0.0.1.0_x64.msix"
"AppPackages\ARM64\TemplateCmdPalExtension_0.0.1.0_arm64_Test\TemplateCmdPalExtension_0.0.1.0_arm64.msix" "TemplateCmdPalExtension_0.0.1.0_arm64.msix"

View File

@@ -0,0 +1,829 @@
# One-Time Publication Setup Script for CmdPal Extension
# This script collects Microsoft Store publication information and updates project files
# Version: 1.1
#Requires -Version 5.1
# Enable strict mode for better error detection
Set-StrictMode -Version Latest
$ErrorActionPreference = "Stop"
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Microsoft Store Publication Setup" -ForegroundColor Cyan
Write-Host " CmdPal Extension Publisher" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
# Path to the project files
$projectRoot = Split-Path -Parent $PSScriptRoot
$csprojPath = Join-Path $projectRoot "TemplateCmdPalExtension.csproj"
$manifestPath = Join-Path $projectRoot "Package.appxmanifest"
Write-Host "Validating project structure..." -ForegroundColor Cyan
Write-Host " Project Root: $projectRoot" -ForegroundColor Gray
# Verify files exist with detailed error messages
if (-not (Test-Path $csprojPath)) {
Write-Host ""
Write-Host "ERROR: Could not find .csproj file" -ForegroundColor Red
Write-Host " Expected location: $csprojPath" -ForegroundColor Gray
Write-Host ""
Write-Host "This script must be run from the Publication folder within your project." -ForegroundColor Yellow
Write-Host "Please navigate to: <YourProject>\Publication\" -ForegroundColor Yellow
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not (Test-Path $manifestPath)) {
Write-Host ""
Write-Host "ERROR: Could not find Package.appxmanifest file" -ForegroundColor Red
Write-Host " Expected location: $manifestPath" -ForegroundColor Gray
Write-Host ""
Write-Host "Your project structure may be incomplete or corrupted." -ForegroundColor Yellow
Write-Host "Please ensure Package.appxmanifest exists in your project root." -ForegroundColor Yellow
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [OK] .csproj file found" -ForegroundColor Green
Write-Host " [OK] Package.appxmanifest file found" -ForegroundColor Green
Write-Host ""
# Create backup directory if it doesn't exist
$backupDir = Join-Path $projectRoot "Publication\Backups"
if (-not (Test-Path $backupDir)) {
try {
New-Item -Path $backupDir -ItemType Directory -Force | Out-Null
Write-Host "Created backup directory: $backupDir" -ForegroundColor Gray
}
catch {
Write-Host "WARNING: Could not create backup directory. Proceeding without backups." -ForegroundColor Yellow
$backupDir = $null
}
}
# Create timestamped backups
if ($backupDir) {
$timestamp = Get-Date -Format "yyyyMMdd-HHmmss"
try {
Copy-Item $csprojPath -Destination (Join-Path $backupDir "TemplateCmdPalExtension.csproj.$timestamp.bak") -Force
Copy-Item $manifestPath -Destination (Join-Path $backupDir "Package.appxmanifest.$timestamp.bak") -Force
Write-Host "Backup created: $timestamp" -ForegroundColor Gray
Write-Host ""
}
catch {
Write-Host "WARNING: Could not create backup files. Proceeding anyway." -ForegroundColor Yellow
Write-Host ""
}
}
Write-Host "This script will collect information needed to publish your extension" -ForegroundColor White
Write-Host "to the Microsoft Store. You can find this information in your" -ForegroundColor White
Write-Host "Microsoft Partner Center account." -ForegroundColor White
Write-Host ""
Write-Host "IMPORTANT: Have your Partner Center information ready before proceeding." -ForegroundColor Yellow
Write-Host " - Package Identity Name" -ForegroundColor Gray
Write-Host " - Publisher Certificate Name" -ForegroundColor Gray
Write-Host " - Reserved App Name" -ForegroundColor Gray
Write-Host " - Publisher Display Name" -ForegroundColor Gray
Write-Host ""
Write-Host "TIP: You can find this in Partner Center > Product Management > Product Identity" -ForegroundColor Cyan
Write-Host ""
# Prompt to continue
Write-Host "Do you want to continue? (Y/N): " -ForegroundColor Yellow -NoNewline
$continue = Read-Host
if ($continue -notmatch '^[Yy]') {
Write-Host ""
Write-Host "Setup cancelled by user." -ForegroundColor Yellow
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 0
}
Write-Host ""
# Function to validate package identity name format
function Test-PackageIdentityName {
param([string]$name)
# Package identity name rules:
# - Between 3 and 50 characters
# - Can contain: letters, numbers, periods, hyphens
# - Cannot start/end with period
# - Cannot have consecutive periods
if ([string]::IsNullOrWhiteSpace($name)) { return $false }
if ($name.Length -lt 3 -or $name.Length -gt 50) { return $false }
if ($name -match '^\.|\.$|\.\.') { return $false }
if ($name -notmatch '^[a-zA-Z0-9.-]+$') { return $false }
return $true
}
# Function to validate publisher certificate format
function Test-PublisherFormat {
param([string]$publisher)
if ([string]::IsNullOrWhiteSpace($publisher)) { return $false }
# Should start with CN= and follow distinguished name format
if ($publisher -notmatch '^CN=.+') { return $false }
# Check for valid characters in DN
if ($publisher -match '[<>]') { return $false }
return $true
}
# Function to validate display name
function Test-DisplayName {
param([string]$name)
if ([string]::IsNullOrWhiteSpace($name)) { return $false }
# Display name should be reasonable length and not contain control characters
if ($name.Length -lt 1 -or $name.Length -gt 256) { return $false }
if ($name -match '[\x00-\x1F\x7F]') { return $false }
return $true
}
# Collect Microsoft Store Package Identity Name
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 1: Package Identity Name" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Enter Microsoft Store Package/Identity/Name:" -ForegroundColor Yellow
Write-Host " Location: Partner Center > Product Identity > Package/Identity/Name" -ForegroundColor Gray
Write-Host ""
Write-Host " Format Requirements:" -ForegroundColor Gray
Write-Host " - 3-50 characters" -ForegroundColor DarkGray
Write-Host " - Letters, numbers, periods, hyphens only" -ForegroundColor DarkGray
Write-Host " - Cannot start/end with period or have consecutive periods" -ForegroundColor DarkGray
Write-Host ""
Write-Host " Example: Publisher.MyAwesomeExtension" -ForegroundColor DarkGray
Write-Host ""
$packageIdentityName = ""
$maxAttempts = 3
$attempt = 0
do {
$attempt++
Write-Host "Package Identity Name" -NoNewline -ForegroundColor Yellow
if ($attempt -gt 1) {
Write-Host " (Attempt $attempt of $maxAttempts)" -NoNewline -ForegroundColor Red
}
Write-Host ": " -NoNewline -ForegroundColor Yellow
$packageIdentityName = Read-Host
if ([string]::IsNullOrWhiteSpace($packageIdentityName)) {
Write-Host " [ERROR] Package Identity Name cannot be empty." -ForegroundColor Red
Write-Host ""
}
elseif (-not (Test-PackageIdentityName $packageIdentityName)) {
Write-Host " [ERROR] Invalid Package Identity Name format." -ForegroundColor Red
Write-Host " Please ensure it meets the format requirements listed above." -ForegroundColor Yellow
Write-Host ""
}
else {
Write-Host " [OK] Package Identity Name accepted: $packageIdentityName" -ForegroundColor Green
Write-Host ""
break
}
if ($attempt -ge $maxAttempts) {
Write-Host ""
Write-Host "Maximum attempts reached. Please verify your Partner Center information and try again." -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
} while ($true)
# Collect Microsoft Store Package Identity Publisher
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 2: Publisher Certificate" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Enter Microsoft Store Package/Identity/Publisher:" -ForegroundColor Yellow
Write-Host " Location: Partner Center > Product Identity > Package/Identity/Publisher" -ForegroundColor Gray
Write-Host ""
Write-Host " Format Requirements:" -ForegroundColor Gray
Write-Host " - Must start with 'CN=' (Certificate Name)" -ForegroundColor DarkGray
Write-Host " - This is the publisher certificate distinguished name" -ForegroundColor DarkGray
Write-Host ""
Write-Host " Example: CN=12345678-1234-1234-1234-123456789012" -ForegroundColor DarkGray
Write-Host " Example: CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US" -ForegroundColor DarkGray
Write-Host ""
$packageIdentityPublisher = ""
$attempt = 0
do {
$attempt++
Write-Host "Publisher Certificate" -NoNewline -ForegroundColor Yellow
if ($attempt -gt 1) {
Write-Host " (Attempt $attempt of $maxAttempts)" -NoNewline -ForegroundColor Red
}
Write-Host ": " -NoNewline -ForegroundColor Yellow
$packageIdentityPublisher = Read-Host
if ([string]::IsNullOrWhiteSpace($packageIdentityPublisher)) {
Write-Host " [ERROR] Publisher cannot be empty." -ForegroundColor Red
Write-Host ""
}
elseif (-not (Test-PublisherFormat $packageIdentityPublisher)) {
if ($packageIdentityPublisher -notmatch '^CN=') {
Write-Host " [ERROR] Publisher must start with 'CN='." -ForegroundColor Red
Write-Host " Copy the entire string from Partner Center, including 'CN='." -ForegroundColor Yellow
}
else {
Write-Host " [ERROR] Invalid publisher format." -ForegroundColor Red
Write-Host " Please ensure you copied the complete certificate name from Partner Center." -ForegroundColor Yellow
}
Write-Host ""
}
else {
Write-Host " [OK] Publisher certificate accepted" -ForegroundColor Green
Write-Host ""
break
}
if ($attempt -ge $maxAttempts) {
Write-Host ""
Write-Host "Maximum attempts reached. Please verify your Partner Center information and try again." -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
} while ($true)
# Collect Reserved Display Name
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 3: Display Name" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Enter the reserved Display Name from Partner Center:" -ForegroundColor Yellow
Write-Host " Location: Partner Center > Product Management > Store Listing" -ForegroundColor Gray
Write-Host ""
Write-Host " This is the app name visible to users in the Microsoft Store." -ForegroundColor Gray
Write-Host " It must match EXACTLY what you reserved in Partner Center." -ForegroundColor Gray
Write-Host ""
Write-Host " Example: My Awesome CmdPal Extension" -ForegroundColor DarkGray
Write-Host ""
$displayName = ""
$attempt = 0
do {
$attempt++
Write-Host "Display Name" -NoNewline -ForegroundColor Yellow
if ($attempt -gt 1) {
Write-Host " (Attempt $attempt of $maxAttempts)" -NoNewline -ForegroundColor Red
}
Write-Host ": " -NoNewline -ForegroundColor Yellow
$displayName = Read-Host
if ([string]::IsNullOrWhiteSpace($displayName)) {
Write-Host " [ERROR] Display Name cannot be empty." -ForegroundColor Red
Write-Host ""
}
elseif (-not (Test-DisplayName $displayName)) {
Write-Host " [ERROR] Invalid Display Name." -ForegroundColor Red
Write-Host " Display name must be 1-256 characters and cannot contain control characters." -ForegroundColor Yellow
Write-Host ""
}
else {
Write-Host " [OK] Display Name accepted: $displayName" -ForegroundColor Green
Write-Host ""
break
}
if ($attempt -ge $maxAttempts) {
Write-Host ""
Write-Host "Maximum attempts reached. Please try again with valid information." -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
} while ($true)
# Collect Publisher Display Name
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 4: Publisher Display Name" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Enter Microsoft Store Package/Properties/PublisherDisplayName:" -ForegroundColor Yellow
Write-Host " Location: Partner Center > Product Identity > Package/Properties" -ForegroundColor Gray
Write-Host ""
Write-Host " This is your company or developer name shown to users." -ForegroundColor Gray
Write-Host ""
Write-Host " Example: Contoso Software Inc." -ForegroundColor DarkGray
Write-Host " Example: Jessica Cha" -ForegroundColor DarkGray
Write-Host ""
$publisherDisplayName = ""
$attempt = 0
do {
$attempt++
Write-Host "Publisher Display Name" -NoNewline -ForegroundColor Yellow
if ($attempt -gt 1) {
Write-Host " (Attempt $attempt of $maxAttempts)" -NoNewline -ForegroundColor Red
}
Write-Host ": " -NoNewline -ForegroundColor Yellow
$publisherDisplayName = Read-Host
if ([string]::IsNullOrWhiteSpace($publisherDisplayName)) {
Write-Host " [ERROR] Publisher Display Name cannot be empty." -ForegroundColor Red
Write-Host ""
}
elseif (-not (Test-DisplayName $publisherDisplayName)) {
Write-Host " [ERROR] Invalid Publisher Display Name." -ForegroundColor Red
Write-Host " Publisher name must be 1-256 characters and cannot contain control characters." -ForegroundColor Yellow
Write-Host ""
}
else {
Write-Host " [OK] Publisher Display Name accepted: $publisherDisplayName" -ForegroundColor Green
Write-Host ""
break
}
if ($attempt -ge $maxAttempts) {
Write-Host ""
Write-Host "Maximum attempts reached. Please try again with valid information." -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
} while ($true)
# Check for required assets
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 5: Validating Required Assets" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Checking for Microsoft Store required asset images..." -ForegroundColor Yellow
Write-Host ""
$assetsPath = Join-Path $projectRoot "Assets"
# Check if Assets folder exists
if (-not (Test-Path $assetsPath)) {
Write-Host " [ERROR] Assets folder not found at: $assetsPath" -ForegroundColor Red
Write-Host ""
Write-Host " Please create the Assets folder and add the required images." -ForegroundColor Yellow
Write-Host " Press any key to continue anyway (you'll need to add assets later)..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
Write-Host ""
}
$requiredAssets = @(
@{ Name = "StoreLogo.png"; Size = "50x50"; Description = "Store logo for listings" },
@{ Name = "Square150x150Logo.scale-200.png"; Size = "300x300"; Description = "Medium tile" },
@{ Name = "Square44x44Logo.scale-200.png"; Size = "88x88"; Description = "App list icon" },
@{ Name = "Wide310x150Logo.scale-200.png"; Size = "620x300"; Description = "Wide tile" },
@{ Name = "SplashScreen.scale-200.png"; Size = "1240x600"; Description = "Splash screen" },
@{ Name = "StoreLogo.scale-100.png"; Size = "50x50"; Description = "Store logo (100% scale)" }
)
$missingAssets = @()
$foundAssets = @()
Write-Host " Asset Validation Results:" -ForegroundColor Cyan
Write-Host " " -NoNewline
Write-Host ("{0,-45} {1,-15} {2}" -f "File", "Size", "Status") -ForegroundColor Gray
Write-Host " " -NoNewline
Write-Host ("{0,-45} {1,-15} {2}" -f "----", "----", "------") -ForegroundColor DarkGray
foreach ($asset in $requiredAssets) {
$assetPath = Join-Path $assetsPath $asset.Name
$statusPrefix = " "
if (Test-Path $assetPath) {
try {
$fileInfo = Get-Item $assetPath
$fileSize = "{0:N2} KB" -f ($fileInfo.Length / 1KB)
Write-Host " " -NoNewline
Write-Host ("{0,-45} {1,-15} " -f $asset.Name, $asset.Size) -NoNewline -ForegroundColor White
Write-Host "[OK]" -ForegroundColor Green
$foundAssets += $asset.Name
}
catch {
Write-Host " " -NoNewline
Write-Host ("{0,-45} {1,-15} " -f $asset.Name, $asset.Size) -NoNewline -ForegroundColor White
Write-Host "[WARNING]" -ForegroundColor Yellow
Write-Host " (File exists but couldn't read properties)" -ForegroundColor DarkGray
$foundAssets += $asset.Name
}
}
else {
Write-Host " " -NoNewline
Write-Host ("{0,-45} {1,-15} " -f $asset.Name, $asset.Size) -NoNewline -ForegroundColor White
Write-Host "[MISSING]" -ForegroundColor Red
Write-Host " ($($asset.Description))" -ForegroundColor DarkGray
$missingAssets += $asset
}
}
Write-Host ""
Write-Host " Summary: " -NoNewline -ForegroundColor Cyan
Write-Host "$($foundAssets.Count) of $($requiredAssets.Count) assets found" -ForegroundColor White
# Auto-fix: Copy StoreLogo.scale-100.png to StoreLogo.png if needed
$storeLogoPath = Join-Path $assetsPath "StoreLogo.png"
$storeLogoScaledPath = Join-Path $assetsPath "StoreLogo.scale-100.png"
if (-not (Test-Path $storeLogoPath) -and (Test-Path $storeLogoScaledPath)) {
Write-Host ""
Write-Host " [AUTO-FIX] Creating StoreLogo.png from StoreLogo.scale-100.png..." -ForegroundColor Cyan
try {
Copy-Item $storeLogoScaledPath -Destination $storeLogoPath -Force -ErrorAction Stop
Write-Host " [SUCCESS] StoreLogo.png created successfully" -ForegroundColor Green
# Update the missing/found counts
$missingAssets = $missingAssets | Where-Object { $_.Name -ne "StoreLogo.png" }
if ($foundAssets -notcontains "StoreLogo.png") {
$foundAssets += "StoreLogo.png"
}
}
catch {
Write-Host " [ERROR] Could not copy file: $($_.Exception.Message)" -ForegroundColor Red
}
}
if ($missingAssets.Count -gt 0) {
Write-Host ""
Write-Host " [WARNING] $($missingAssets.Count) asset(s) missing" -ForegroundColor Yellow
Write-Host ""
Write-Host " The Microsoft Store requires specific image assets for your app listing." -ForegroundColor Gray
Write-Host " You'll need to add these before you can publish." -ForegroundColor Gray
Write-Host ""
Write-Host " TIP: Use the Windows App SDK project templates or design tools to create" -ForegroundColor Cyan
Write-Host " properly sized assets. Each image must be exactly the size specified." -ForegroundColor Cyan
Write-Host ""
}
else {
Write-Host " [OK] All required assets are present!" -ForegroundColor Green
Write-Host ""
}
Write-Host ""
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Updating Project Files..." -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "The script will now update your project files with the information you provided." -ForegroundColor White
Write-Host "Original files have been backed up in the Publication\Backups folder." -ForegroundColor Gray
Write-Host ""
# Update Package.appxmanifest
Write-Host "[1/2] Updating Package.appxmanifest..." -ForegroundColor Cyan
try {
$manifestContent = Get-Content $manifestPath -Raw -ErrorAction Stop
}
catch {
Write-Host " [ERROR] Could not read Package.appxmanifest: $($_.Exception.Message)" -ForegroundColor Red
Write-Host " The file may be locked by another process." -ForegroundColor Yellow
Write-Host " Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
# Backup original content
$manifestBackup = $manifestContent
$manifestUpdateCount = 0
# Update Identity element (Name and Publisher)
Write-Host " Updating Identity Name..." -NoNewline -ForegroundColor Gray
$identityNamePattern = '(?<=<Identity\s+Name=")[^"]*'
if ($manifestContent -match $identityNamePattern) {
$oldValue = $Matches[0]
$identityNameUpdated = $manifestContent -replace $identityNamePattern, $packageIdentityName
if ($identityNameUpdated -ne $manifestContent) {
$manifestContent = $identityNameUpdated
$manifestUpdateCount++
Write-Host " [OK]" -ForegroundColor Green
Write-Host " Changed from: '$oldValue'" -ForegroundColor DarkGray
Write-Host " Changed to: '$packageIdentityName'" -ForegroundColor DarkGray
}
else {
Write-Host " [NO CHANGE]" -ForegroundColor Yellow
}
}
else {
Write-Host " [WARNING] Could not find Identity Name attribute" -ForegroundColor Yellow
}
Write-Host " Updating Publisher..." -NoNewline -ForegroundColor Gray
$publisherPattern = '(?<=Publisher=")[^"]*(?=")'
if ($manifestContent -match $publisherPattern) {
$oldValue = $Matches[0]
$identityPublisherUpdated = $manifestContent -replace $publisherPattern, $packageIdentityPublisher
if ($identityPublisherUpdated -ne $manifestContent) {
$manifestContent = $identityPublisherUpdated
$manifestUpdateCount++
Write-Host " [OK]" -ForegroundColor Green
Write-Host " Changed from: '$oldValue'" -ForegroundColor DarkGray
Write-Host " Changed to: '$packageIdentityPublisher'" -ForegroundColor DarkGray
}
else {
Write-Host " [NO CHANGE]" -ForegroundColor Yellow
}
}
else {
Write-Host " [WARNING] Could not find Publisher attribute" -ForegroundColor Yellow
}
# Update Properties (DisplayName and PublisherDisplayName)
Write-Host " Updating Display Name..." -NoNewline -ForegroundColor Gray
$displayNamePattern = '(?<=<DisplayName>)[^<]*(?=</DisplayName>)'
if ($manifestContent -match $displayNamePattern) {
$oldValue = $Matches[0]
$displayNameUpdated = $manifestContent -replace $displayNamePattern, $displayName
if ($displayNameUpdated -ne $manifestContent) {
$manifestContent = $displayNameUpdated
$manifestUpdateCount++
Write-Host " [OK]" -ForegroundColor Green
Write-Host " Changed from: '$oldValue'" -ForegroundColor DarkGray
Write-Host " Changed to: '$displayName'" -ForegroundColor DarkGray
}
else {
Write-Host " [NO CHANGE]" -ForegroundColor Yellow
}
}
else {
Write-Host " [WARNING] Could not find DisplayName element" -ForegroundColor Yellow
}
Write-Host " Updating Publisher Display Name..." -NoNewline -ForegroundColor Gray
$publisherDisplayNamePattern = '(?<=<PublisherDisplayName>)[^<]*(?=</PublisherDisplayName>)'
if ($manifestContent -match $publisherDisplayNamePattern) {
$oldValue = $Matches[0]
$publisherDisplayNameUpdated = $manifestContent -replace $publisherDisplayNamePattern, $publisherDisplayName
if ($publisherDisplayNameUpdated -ne $manifestContent) {
$manifestContent = $publisherDisplayNameUpdated
$manifestUpdateCount++
Write-Host " [OK]" -ForegroundColor Green
Write-Host " Changed from: '$oldValue'" -ForegroundColor DarkGray
Write-Host " Changed to: '$publisherDisplayName'" -ForegroundColor DarkGray
}
else {
Write-Host " [NO CHANGE]" -ForegroundColor Yellow
}
}
else {
Write-Host " [WARNING] Could not find PublisherDisplayName element" -ForegroundColor Yellow
}
# Also update the VisualElements DisplayName
Write-Host " Updating VisualElements Display Name..." -NoNewline -ForegroundColor Gray
$visualElementsPattern = '(?<=<uap:VisualElements[^>]*DisplayName=")[^"]*'
if ($manifestContent -match $visualElementsPattern) {
$oldValue = $Matches[0]
if ($oldValue -ne $displayName) {
$visualElementsUpdated = $manifestContent -replace $visualElementsPattern, $displayName
if ($visualElementsUpdated -ne $manifestContent) {
$manifestContent = $visualElementsUpdated
$manifestUpdateCount++
Write-Host " [OK]" -ForegroundColor Green
}
else {
Write-Host " [NO CHANGE]" -ForegroundColor Yellow
}
}
else {
Write-Host " [ALREADY SET]" -ForegroundColor Green
}
}
else {
Write-Host " [SKIP]" -ForegroundColor Gray
}
# Write the updated manifest
if ($manifestContent -ne $manifestBackup) {
try {
Set-Content -Path $manifestPath -Value $manifestContent -NoNewline -ErrorAction Stop
Write-Host ""
Write-Host " [SUCCESS] Package.appxmanifest updated ($manifestUpdateCount changes)" -ForegroundColor Green
}
catch {
Write-Host ""
Write-Host " [ERROR] Could not write to Package.appxmanifest: $($_.Exception.Message)" -ForegroundColor Red
Write-Host " The file may be read-only or locked by another process." -ForegroundColor Yellow
Write-Host " Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
}
else {
Write-Host ""
Write-Host " [INFO] No changes were needed for Package.appxmanifest" -ForegroundColor Cyan
}
Write-Host ""
# Update .csproj file
Write-Host "[2/2] Updating TemplateCmdPalExtension.csproj..." -ForegroundColor Cyan
try {
$csprojContent = Get-Content $csprojPath -Raw -ErrorAction Stop
}
catch {
Write-Host " [ERROR] Could not read .csproj file: $($_.Exception.Message)" -ForegroundColor Red
Write-Host " The file may be locked by another process." -ForegroundColor Yellow
Write-Host " Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
# Backup original content
$csprojBackup = $csprojContent
$csprojUpdateCount = 0
# Check if Store properties are commented or uncommented
Write-Host " Checking Store property configuration..." -NoNewline -ForegroundColor Gray
$storePropsCommentedPattern = '<!--\s*<AppxPackageIdentityName>YOUR_PACKAGE_IDENTITY_NAME_HERE</AppxPackageIdentityName>\s*<AppxPackagePublisher>YOUR_PACKAGE_IDENTITY_PUBLISHER_HERE</AppxPackagePublisher>\s*<AppxPackageVersion>[^<]*</AppxPackageVersion>\s*-->'
if ($csprojContent -match $storePropsCommentedPattern) {
Write-Host " [COMMENTED]" -ForegroundColor Yellow
Write-Host " Uncommenting and updating Store properties..." -ForegroundColor Gray
# Uncomment and update the Store-specific properties
$replacement = "<AppxPackageIdentityName>$packageIdentityName</AppxPackageIdentityName>`n <AppxPackagePublisher>$packageIdentityPublisher</AppxPackagePublisher>`n <AppxPackageVersion>0.0.1.0</AppxPackageVersion>"
$csprojContent = $csprojContent -replace $storePropsCommentedPattern, $replacement
$csprojUpdateCount++
Write-Host " [OK] Store properties uncommented and updated" -ForegroundColor Green
}
else {
Write-Host " [UNCOMMENTED]" -ForegroundColor Green
Write-Host " Updating existing Store property values..." -ForegroundColor Gray
# Try updating already-uncommented properties
$identityNamePattern = '(?<=<AppxPackageIdentityName>)[^<]*(?=</AppxPackageIdentityName>)'
if ($csprojContent -match $identityNamePattern) {
$oldValue = $Matches[0]
if ($oldValue -ne $packageIdentityName) {
$csprojContent = $csprojContent -replace $identityNamePattern, $packageIdentityName
$csprojUpdateCount++
Write-Host " Updated AppxPackageIdentityName" -ForegroundColor Green
}
}
$publisherPattern = '(?<=<AppxPackagePublisher>)[^<]*(?=</AppxPackagePublisher>)'
if ($csprojContent -match $publisherPattern) {
$oldValue = $Matches[0]
if ($oldValue -ne $packageIdentityPublisher) {
$csprojContent = $csprojContent -replace $publisherPattern, $packageIdentityPublisher
$csprojUpdateCount++
Write-Host " Updated AppxPackagePublisher" -ForegroundColor Green
}
}
}
# Uncomment the PrepareAssets Target section (using (?s) for multi-line matching)
Write-Host " Checking PrepareAssets Target..." -NoNewline -ForegroundColor Gray
$targetPattern = '(?s)<!--\s*(<Target Name="PrepareAssets".*?</Target>)\s*-->'
if ($csprojContent -match $targetPattern) {
Write-Host " [COMMENTED]" -ForegroundColor Yellow
Write-Host " Uncommenting PrepareAssets Target..." -ForegroundColor Gray
$targetReplacement = '$1'
$targetUpdated = $csprojContent -replace $targetPattern, $targetReplacement
if ($targetUpdated -ne $csprojContent) {
$csprojContent = $targetUpdated
$csprojUpdateCount++
Write-Host " [OK] PrepareAssets Target uncommented" -ForegroundColor Green
}
else {
Write-Host " [WARNING] Could not uncomment PrepareAssets Target" -ForegroundColor Yellow
}
}
else {
Write-Host " [ALREADY UNCOMMENTED]" -ForegroundColor Green
}
# Write the updated csproj
if ($csprojContent -ne $csprojBackup) {
try {
Set-Content -Path $csprojPath -Value $csprojContent -NoNewline -ErrorAction Stop
Write-Host ""
Write-Host " [SUCCESS] TemplateCmdPalExtension.csproj updated ($csprojUpdateCount changes)" -ForegroundColor Green
}
catch {
Write-Host ""
Write-Host " [ERROR] Could not write to .csproj file: $($_.Exception.Message)" -ForegroundColor Red
Write-Host " The file may be read-only or locked by another process." -ForegroundColor Yellow
Write-Host " Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
}
else {
Write-Host ""
Write-Host " [INFO] No changes were needed for TemplateCmdPalExtension.csproj" -ForegroundColor Cyan
}
Write-Host ""
# Display summary
Write-Host "=================================================================" -ForegroundColor Cyan
Write-Host " CONFIGURATION SUMMARY" -ForegroundColor White
Write-Host "=================================================================" -ForegroundColor Cyan
Write-Host " Package Identity Name:" -ForegroundColor Gray
Write-Host " $packageIdentityName" -ForegroundColor White
Write-Host ""
Write-Host " Publisher:" -ForegroundColor Gray
# Truncate publisher if too long
$publisherDisplay = if ($packageIdentityPublisher.Length -gt 80) {
$packageIdentityPublisher.Substring(0, 77) + "..."
} else {
$packageIdentityPublisher
}
Write-Host " $publisherDisplay" -ForegroundColor White
Write-Host ""
Write-Host " Display Name:" -ForegroundColor Gray
Write-Host " $displayName" -ForegroundColor White
Write-Host ""
Write-Host " Publisher Display Name:" -ForegroundColor Gray
Write-Host " $publisherDisplayName" -ForegroundColor White
Write-Host "=================================================================" -ForegroundColor Cyan
Write-Host ""
# Display modified files
Write-Host "Modified Files:" -ForegroundColor Yellow
$manifestRelative = $manifestPath -replace [regex]::Escape($projectRoot), "."
$csprojRelative = $csprojPath -replace [regex]::Escape($projectRoot), "."
Write-Host "$manifestRelative" -ForegroundColor Green
Write-Host "$csprojRelative" -ForegroundColor Green
Write-Host ""
if ($backupDir) {
Write-Host "Backup Location:" -ForegroundColor Yellow
$backupRelative = $backupDir -replace [regex]::Escape($projectRoot), "."
Write-Host " $backupRelative" -ForegroundColor Gray
Write-Host ""
}
# Asset status
if ($missingAssets.Count -gt 0) {
Write-Host "=================================================================" -ForegroundColor Red
Write-Host " ACTION REQUIRED: Missing Assets" -ForegroundColor Yellow
Write-Host "=================================================================" -ForegroundColor Red
Write-Host " $($missingAssets.Count) required asset(s) are missing. Add them before publishing:" -ForegroundColor White
Write-Host ""
foreach ($asset in $missingAssets) {
Write-Host " * $($asset.Name) ($($asset.Size))" -ForegroundColor White
}
Write-Host "=================================================================" -ForegroundColor Red
Write-Host ""
Write-Host "Asset Creation Tips:" -ForegroundColor Cyan
Write-Host " * Use PNG format with transparency where appropriate" -ForegroundColor Gray
Write-Host " * Follow Microsoft Store asset guidelines" -ForegroundColor Gray
Write-Host " * Reference: https://learn.microsoft.com/windows/apps/design/style/app-icons-and-logos" -ForegroundColor DarkCyan
Write-Host ""
}
else {
Write-Host " [OK] All required assets are present" -ForegroundColor Green
Write-Host ""
}
# Final success message with conditional messaging
Write-Host "=================================================================" -ForegroundColor Green
if ($missingAssets.Count -gt 0) {
Write-Host " Setup Complete - Action Required" -ForegroundColor Yellow
Write-Host "=================================================================" -ForegroundColor Yellow
Write-Host ""
Write-Host " Your project has been configured for Microsoft Store publishing." -ForegroundColor White
Write-Host " However, you need to add $($missingAssets.Count) missing asset(s) before publishing." -ForegroundColor Yellow
}
else {
Write-Host " Setup Completed Successfully!" -ForegroundColor Green
Write-Host "=================================================================" -ForegroundColor Green
Write-Host ""
Write-Host " Your extension is ready for Microsoft Store publishing!" -ForegroundColor White
Write-Host " All configuration and assets are in place." -ForegroundColor Green
}
Write-Host ""
Write-Host "Next Steps:" -ForegroundColor Cyan
Write-Host " 1. Build MSIX bundles by running:" -ForegroundColor Gray
Write-Host " .\build-msix-bundles.ps1" -ForegroundColor White
Write-Host ""
Write-Host " 2. Upload the bundle to Microsoft Store Partner Center" -ForegroundColor Gray
Write-Host " (Located in Publication\ folder after build)" -ForegroundColor DarkGray
Write-Host ""
Write-Host " 3. Follow submission instructions at:" -ForegroundColor Gray
Write-Host " https://learn.microsoft.com/windows/powertoys/command-palette/publish-extension" -ForegroundColor DarkCyan
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")

View File

@@ -0,0 +1,512 @@
# One-Time WinGet Publication Setup Script for CmdPal Extension
# This script collects information and updates files needed for WinGet publication via EXE installer
# Version: 1.0
#Requires -Version 5.1
# Enable strict mode for better error detection
Set-StrictMode -Version Latest
$ErrorActionPreference = "Stop"
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " WinGet Publication Setup (EXE Installer)" -ForegroundColor Cyan
Write-Host " CmdPal Extension Publisher" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
# Path to the project files
$publicationRoot = $PSScriptRoot
$projectRoot = Split-Path -Parent $publicationRoot
$projectName = Split-Path -Leaf $projectRoot
$wingetResourcesPath = Join-Path $PSScriptRoot "winget-resources"
Write-Host "Validating project structure..." -ForegroundColor Cyan
Write-Host " Publication Root: $publicationRoot" -ForegroundColor Gray
Write-Host " Project Root: $projectRoot" -ForegroundColor Gray
Write-Host " Project Name: $projectName" -ForegroundColor Gray
Write-Host ""
# Verify required files exist
$csprojPath = Join-Path $projectRoot "$projectName.csproj"
$manifestPath = Join-Path $projectRoot "Package.appxmanifest"
$extensionCsPath = Join-Path $projectRoot "$projectName.cs"
$buildExePath = Join-Path $wingetResourcesPath "build-exe.ps1"
$setupTemplatePath = Join-Path $wingetResourcesPath "setup-template.iss"
$releaseYmlPath = Join-Path $wingetResourcesPath "release-extension.yml"
if (-not (Test-Path $csprojPath)) {
Write-Host "ERROR: Could not find .csproj file at: $csprojPath" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not (Test-Path $manifestPath)) {
Write-Host "ERROR: Could not find Package.appxmanifest at: $manifestPath" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not (Test-Path $buildExePath)) {
Write-Host "ERROR: Could not find build-exe.ps1 at: $buildExePath" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not (Test-Path $setupTemplatePath)) {
Write-Host "ERROR: Could not find setup-template.iss at: $setupTemplatePath" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
if (-not (Test-Path $releaseYmlPath)) {
Write-Host "ERROR: Could not find release-extension.yml at: $releaseYmlPath" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host " [OK] All required files found" -ForegroundColor Green
Write-Host ""
# Create backup directory
$backupDir = Join-Path $wingetResourcesPath "Backups"
if (-not (Test-Path $backupDir)) {
try {
New-Item -Path $backupDir -ItemType Directory -Force | Out-Null
Write-Host "Created backup directory: $backupDir" -ForegroundColor Gray
}
catch {
Write-Host "WARNING: Could not create backup directory. Proceeding without backups." -ForegroundColor Yellow
$backupDir = $null
}
}
# Create timestamped backups
if ($backupDir) {
$timestamp = Get-Date -Format "yyyyMMdd-HHmmss"
try {
Copy-Item $buildExePath -Destination (Join-Path $backupDir "build-exe.ps1.$timestamp.bak") -Force
Copy-Item $setupTemplatePath -Destination (Join-Path $backupDir "setup-template.iss.$timestamp.bak") -Force
Copy-Item $releaseYmlPath -Destination (Join-Path $backupDir "release-extension.yml.$timestamp.bak") -Force
Write-Host "Backups created: $timestamp" -ForegroundColor Gray
Write-Host ""
}
catch {
Write-Host "WARNING: Could not create backup files. Proceeding anyway." -ForegroundColor Yellow
Write-Host ""
}
}
# Read existing project information
Write-Host "Reading project information..." -ForegroundColor Cyan
try {
[xml]$manifest = Get-Content $manifestPath -ErrorAction Stop
$packageName = $manifest.Package.Identity.Name
$packageVersion = $manifest.Package.Identity.Version
$displayName = $manifest.Package.Properties.DisplayName
$publisherDisplayName = $manifest.Package.Properties.PublisherDisplayName
Write-Host " Current Package Name: $packageName" -ForegroundColor White
Write-Host " Current Version: $packageVersion" -ForegroundColor White
Write-Host " Current Display Name: $displayName" -ForegroundColor White
Write-Host " Current Publisher: $publisherDisplayName" -ForegroundColor White
Write-Host ""
}
catch {
Write-Host "ERROR: Could not read Package.appxmanifest: $($_.Exception.Message)" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
# Extract GUID/CLSID from extension class
Write-Host "Reading extension GUID..." -ForegroundColor Cyan
try {
$extensionCsContent = Get-Content $extensionCsPath -Raw -ErrorAction Stop
if ($extensionCsContent -match '\[Guid\("([A-F0-9-]+)"\)\]') {
$extensionGuid = $Matches[1]
Write-Host " Extension GUID: $extensionGuid" -ForegroundColor White
Write-Host ""
}
else {
Write-Host "ERROR: Could not find GUID in $projectName.cs" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
}
catch {
Write-Host "ERROR: Could not read $projectName.cs: $($_.Exception.Message)" -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
Write-Host "This script will configure your extension for WinGet publication using EXE installer." -ForegroundColor White
Write-Host ""
Write-Host "The following information will be collected:" -ForegroundColor White
Write-Host " - GitHub Repository URL (for releases)" -ForegroundColor Gray
Write-Host " - Developer/Publisher Name" -ForegroundColor Gray
Write-Host ""
Write-Host "The script will update:" -ForegroundColor Yellow
Write-Host " - build-exe.ps1 (build script)" -ForegroundColor Gray
Write-Host " - setup-template.iss (Inno Setup installer script)" -ForegroundColor Gray
Write-Host " - release-extension.yml (GitHub Actions workflow)" -ForegroundColor Gray
Write-Host ""
# Function to validate URL
function Test-GitHubUrl {
param([string]$url)
if ([string]::IsNullOrWhiteSpace($url)) { return $false }
if ($url -notmatch '^https://github\.com/[a-zA-Z0-9_-]+/[a-zA-Z0-9_.-]+/?$') { return $false }
return $true
}
# Function to validate developer name
function Test-DeveloperName {
param([string]$name)
if ([string]::IsNullOrWhiteSpace($name)) { return $false }
if ($name.Length -lt 1 -or $name.Length -gt 256) { return $false }
return $true
}
# Prompt to continue
Write-Host "Do you want to continue? (Y/N): " -ForegroundColor Yellow -NoNewline
$continue = Read-Host
if ($continue -notmatch '^[Yy]') {
Write-Host ""
Write-Host "Setup cancelled by user." -ForegroundColor Yellow
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 0
}
Write-Host ""
# Collect GitHub Repository URL
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 1: GitHub Repository URL" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Enter your GitHub repository URL:" -ForegroundColor Yellow
Write-Host " This is where your extension's releases will be published." -ForegroundColor Gray
Write-Host ""
Write-Host " Format: https://github.com/username/repository" -ForegroundColor DarkGray
Write-Host " Example: https://github.com/johndoe/MyAwesomeExtension" -ForegroundColor DarkGray
Write-Host ""
$githubRepoUrl = ""
$maxAttempts = 3
$attempt = 0
do {
$attempt++
Write-Host "GitHub Repository URL" -NoNewline -ForegroundColor Yellow
if ($attempt -gt 1) {
Write-Host " (Attempt $attempt of $maxAttempts)" -NoNewline -ForegroundColor Red
}
Write-Host ": " -NoNewline -ForegroundColor Yellow
$githubRepoUrl = Read-Host
if ([string]::IsNullOrWhiteSpace($githubRepoUrl)) {
Write-Host " [ERROR] GitHub Repository URL cannot be empty." -ForegroundColor Red
Write-Host ""
}
elseif (-not (Test-GitHubUrl $githubRepoUrl)) {
Write-Host " [ERROR] Invalid GitHub URL format." -ForegroundColor Red
Write-Host " Please use format: https://github.com/username/repository" -ForegroundColor Yellow
Write-Host ""
}
else {
Write-Host " [OK] GitHub Repository URL accepted: $githubRepoUrl" -ForegroundColor Green
Write-Host ""
break
}
if ($attempt -ge $maxAttempts) {
Write-Host ""
Write-Host "Maximum attempts reached. Please try again with a valid GitHub URL." -ForegroundColor Red
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
exit 1
}
} while ($true)
# Collect Developer Name
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Step 2: Developer/Publisher Name" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "Enter your developer or publisher name:" -ForegroundColor Yellow
Write-Host " This will appear in the EXE installer as the publisher." -ForegroundColor Gray
Write-Host ""
Write-Host " IMPORTANT: If you published to Microsoft Store, this should match" -ForegroundColor Yellow
Write-Host " the PublisherDisplayName from your Store configuration." -ForegroundColor Yellow
Write-Host ""
Write-Host " Example: John Doe" -ForegroundColor DarkGray
Write-Host " Example: Contoso Software" -ForegroundColor DarkGray
Write-Host ""
Write-Host " Current value from manifest: $publisherDisplayName" -ForegroundColor Cyan
Write-Host ""
$developerName = ""
$attempt = 0
do {
$attempt++
Write-Host "Developer Name" -NoNewline -ForegroundColor Yellow
if ($attempt -gt 1) {
Write-Host " (Attempt $attempt of $maxAttempts)" -NoNewline -ForegroundColor Red
}
Write-Host " [press Enter to use default]: " -NoNewline -ForegroundColor Yellow
$input = Read-Host
if ([string]::IsNullOrWhiteSpace($input)) {
$developerName = $publisherDisplayName
Write-Host " [OK] Using default: $developerName" -ForegroundColor Green
Write-Host ""
break
}
elseif (-not (Test-DeveloperName $input)) {
Write-Host " [ERROR] Invalid developer name." -ForegroundColor Red
Write-Host ""
}
else {
$developerName = $input
Write-Host " [OK] Developer name accepted: $developerName" -ForegroundColor Green
Write-Host ""
break
}
if ($attempt -ge $maxAttempts) {
Write-Host ""
Write-Host "Maximum attempts reached. Using default: $publisherDisplayName" -ForegroundColor Yellow
$developerName = $publisherDisplayName
Write-Host ""
break
}
} while ($true)
# Update files
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Updating Configuration Files..." -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
# Update build-exe.ps1
Write-Host "[1/3] Updating build-exe.ps1..." -ForegroundColor Cyan
try {
$buildExeContent = Get-Content $buildExePath -Raw -ErrorAction Stop
# Update ExtensionName default value
$buildExeContent = $buildExeContent -replace '\[string\]\$ExtensionName = "UPDATE"', "[string]`$ExtensionName = `"$projectName`""
# Update Version default value
$buildExeContent = $buildExeContent -replace '\[string\]\$Version = "UPDATE"', "[string]`$Version = `"$packageVersion`""
Set-Content -Path $buildExePath -Value $buildExeContent -NoNewline -ErrorAction Stop
Write-Host " [SUCCESS] build-exe.ps1 updated" -ForegroundColor Green
Write-Host ""
}
catch {
Write-Host " [ERROR] Could not update build-exe.ps1: $($_.Exception.Message)" -ForegroundColor Red
Write-Host ""
}
# Update setup-template.iss
Write-Host "[2/3] Updating setup-template.iss..." -ForegroundColor Cyan
try {
$setupTemplateContent = Get-Content $setupTemplatePath -Raw -ErrorAction Stop
# Update version
$setupTemplateContent = $setupTemplateContent -replace '#define AppVersion ".*"', "#define AppVersion `"$packageVersion`""
# Update AppId GUID
$setupTemplateContent = $setupTemplateContent -replace 'AppId=\{\{GUID-HERE\}\}', "AppId={{$extensionGuid}}"
# Update AppName (DISPLAY_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'AppName=DISPLAY_NAME', "AppName=$displayName"
# Update AppPublisher (DEVELOPER_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'AppPublisher=DEVELOPER_NAME', "AppPublisher=$developerName"
# Update DefaultDirName (EXTENSION_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'DefaultDirName=\{autopf\}\\EXTENSION_NAME', "DefaultDirName={autopf}\$projectName"
# Update OutputBaseFilename (EXTENSION_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'OutputBaseFilename=EXTENSION_NAME-Setup', "OutputBaseFilename=$projectName-Setup"
# Update Icon name (DISPLAY_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'Name: "\{group\}\\DISPLAY_NAME"', "Name: `"{group}\$displayName`""
# Update Icon filename (EXTENSION_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'Filename: "\{app\}\\EXTENSION_NAME\.exe"', "Filename: `"{app}\$projectName.exe`""
# Update Registry CLSID entries
$setupTemplateContent = $setupTemplateContent -replace 'CLSID\\CLSID-HERE', "CLSID\{{$extensionGuid}}"
$setupTemplateContent = $setupTemplateContent -replace '\{\{CLSID-HERE\}\}', "{{$extensionGuid}}"
# Update Registry ValueData (EXTENSION_NAME)
$setupTemplateContent = $setupTemplateContent -replace 'ValueData: "EXTENSION_NAME"', "ValueData: `"$projectName`""
# Update LocalServer32 ValueData
$setupTemplateContent = $setupTemplateContent -replace 'ValueData: "\{app\}\\EXTENSION_NAME\.exe', "ValueData: `"{app}\$projectName.exe"
Set-Content -Path $setupTemplatePath -Value $setupTemplateContent -NoNewline -ErrorAction Stop
Write-Host " [SUCCESS] setup-template.iss updated" -ForegroundColor Green
Write-Host ""
}
catch {
Write-Host " [ERROR] Could not update setup-template.iss: $($_.Exception.Message)" -ForegroundColor Red
Write-Host ""
}
# Update release-extension.yml
Write-Host "[3/3] Updating release-extension.yml..." -ForegroundColor Cyan
try {
$releaseYmlContent = Get-Content $releaseYmlPath -Raw -ErrorAction Stop
# Update workflow name
$releaseYmlContent = $releaseYmlContent -replace 'name: CmdPal Extension - Build EXE Installer', "name: $displayName - Build EXE Installer"
# Update environment variables with actual values
$releaseYmlContent = $releaseYmlContent -replace "DISPLAY_NAME: \$\{\{ vars\.DISPLAY_NAME \|\| 'DISPLAY_NAME' \}\}", "DISPLAY_NAME: `${{ vars.DISPLAY_NAME || '$displayName' }}"
$releaseYmlContent = $releaseYmlContent -replace "EXTENSION_NAME: \$\{\{ vars\.EXTENSION_NAME \|\| 'EXTENSION_NAME' \}\}", "EXTENSION_NAME: `${{ vars.EXTENSION_NAME || '$projectName' }}"
$releaseYmlContent = $releaseYmlContent -replace "FOLDER_NAME: \$\{\{ vars\.FOLDER_NAME \|\| 'FOLDER_NAME' \}\}", "FOLDER_NAME: `${{ vars.FOLDER_NAME || '$projectName' }}"
$releaseYmlContent = $releaseYmlContent -replace "GITHUB_REPO_URL: \$\{\{ vars\.GITHUB_REPO_URL \|\| 'GITHUB_REPO_URL' \}\}", "GITHUB_REPO_URL: `${{ vars.GITHUB_REPO_URL || '$githubRepoUrl' }}"
Set-Content -Path $releaseYmlPath -Value $releaseYmlContent -NoNewline -ErrorAction Stop
Write-Host " [SUCCESS] release-extension.yml updated" -ForegroundColor Green
Write-Host ""
}
catch {
Write-Host " [ERROR] Could not update release-extension.yml: $($_.Exception.Message)" -ForegroundColor Red
Write-Host ""
}
# Display summary
Write-Host "================================================================" -ForegroundColor Green
Write-Host " CONFIGURATION SUMMARY" -ForegroundColor White
Write-Host "================================================================" -ForegroundColor Green
Write-Host " Extension Name:" -ForegroundColor Gray
Write-Host " $projectName" -ForegroundColor White
Write-Host ""
Write-Host " Display Name:" -ForegroundColor Gray
Write-Host " $displayName" -ForegroundColor White
Write-Host ""
Write-Host " Version:" -ForegroundColor Gray
Write-Host " $packageVersion" -ForegroundColor White
Write-Host ""
Write-Host " Developer:" -ForegroundColor Gray
Write-Host " $developerName" -ForegroundColor White
Write-Host ""
Write-Host " Extension GUID:" -ForegroundColor Gray
Write-Host " $extensionGuid" -ForegroundColor White
Write-Host ""
Write-Host " GitHub Repository:" -ForegroundColor Gray
Write-Host " $githubRepoUrl" -ForegroundColor White
Write-Host "================================================================" -ForegroundColor Green
Write-Host ""
# Display modified files
Write-Host "Updated Files:" -ForegroundColor Yellow
$buildExeRelative = $buildExePath -replace [regex]::Escape($projectRoot + "\"), ""
$setupTemplateRelative = $setupTemplatePath -replace [regex]::Escape($projectRoot + "\"), ""
$releaseYmlRelative = $releaseYmlPath -replace [regex]::Escape($projectRoot + "\"), ""
Write-Host " [OK] $buildExeRelative" -ForegroundColor Green
Write-Host " [OK] $setupTemplateRelative" -ForegroundColor Green
Write-Host " [OK] $releaseYmlRelative" -ForegroundColor Green
Write-Host ""
if ($backupDir) {
Write-Host "Backup Location:" -ForegroundColor Yellow
$backupRelative = $backupDir -replace [regex]::Escape($projectRoot + "\"), ""
Write-Host " $backupRelative" -ForegroundColor Gray
Write-Host ""
}
# Move files to correct locations
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host " Moving Files to Correct Locations" -ForegroundColor Cyan
Write-Host "================================================================" -ForegroundColor Cyan
Write-Host ""
Write-Host "The following file will be moved:" -ForegroundColor Yellow
Write-Host " - release-extension.yml → .github/workflows/ (2 levels up)" -ForegroundColor Gray
Write-Host ""
Write-Host "The following files will remain in winget-resources:" -ForegroundColor Yellow
Write-Host " - build-exe.ps1" -ForegroundColor Gray
Write-Host " - setup-template.iss" -ForegroundColor Gray
Write-Host ""
# Calculate destination paths
# From: TemplateCmdPalExtension/Publication/winget-resources/
# release-extension.yml → TemplateCmdPalExtension/.github/workflows/ (2 levels up from Publication)
# GitHub workflows directory (2 levels up from Publication)
$solutionRoot = Split-Path -Parent $projectRoot
$githubWorkflowsDir = Join-Path $solutionRoot ".github\workflows"
$releaseYmlDestination = Join-Path $githubWorkflowsDir "release-extension.yml"
Write-Host "Destination:" -ForegroundColor Yellow
Write-Host " release-extension.yml → $releaseYmlDestination" -ForegroundColor Gray
Write-Host ""
# Move release-extension.yml
Write-Host "Moving release-extension.yml..." -ForegroundColor Cyan
try {
if (-not (Test-Path $githubWorkflowsDir)) {
Write-Host " Creating .github/workflows directory..." -ForegroundColor Gray
New-Item -Path $githubWorkflowsDir -ItemType Directory -Force | Out-Null
}
if (Test-Path $releaseYmlDestination) {
Write-Host " [WARNING] Destination file exists, overwriting..." -ForegroundColor Yellow
}
Move-Item $releaseYmlPath -Destination $releaseYmlDestination -Force -ErrorAction Stop
Write-Host " [SUCCESS] Moved to: $releaseYmlDestination" -ForegroundColor Green
}
catch {
Write-Host " [ERROR] Could not move release-extension.yml: $($_.Exception.Message)" -ForegroundColor Red
}
Write-Host ""
# Verify file was moved
Write-Host "Verifying file..." -ForegroundColor Cyan
if (Test-Path $releaseYmlDestination) {
Write-Host " [OK] release-extension.yml exists at destination" -ForegroundColor Green
}
else {
Write-Host " [ERROR] release-extension.yml NOT found at destination" -ForegroundColor Red
}
Write-Host ""
# Final instructions
Write-Host "================================================================" -ForegroundColor Green
Write-Host " Setup Completed Successfully!" -ForegroundColor Green
Write-Host "================================================================" -ForegroundColor Green
Write-Host ""
Write-Host "Files have been configured:" -ForegroundColor Yellow
Write-Host " Updated (in winget-resources):" -ForegroundColor Cyan
Write-Host " $buildExePath" -ForegroundColor White
Write-Host " $setupTemplatePath" -ForegroundColor White
Write-Host ""
Write-Host " Moved to GitHub workflows:" -ForegroundColor Cyan
Write-Host " $releaseYmlDestination" -ForegroundColor White
Write-Host ""
Write-Host "Next Steps:" -ForegroundColor Cyan
Write-Host " 1. Review the configured files to ensure correctness" -ForegroundColor Gray
Write-Host " 2. Add and commit files and push to Github" -ForegroundColor Gray
Write-Host " 3. Follow instructions at https://learn.microsoft.com//windows/powertoys/command-palette/publish-extension" -ForegroundColor Gray
Write-Host ""
Write-Host "Press any key to exit..." -ForegroundColor Gray
$null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")

View File

@@ -0,0 +1,114 @@
# TEMPLATE: PowerShell Build Script for Command Palette Extensions
#
# To use this template for a new extension:
# 1. Copy this file to your extension's project folder as "build-exe.ps1"
# 2. Update in param():
# - EXTENSION_NAME with your extension name (e.g., CmdPalMyExtension)
# - VERSION with your extension version (e.g., 0.0.1.0)
param(
[string]$ExtensionName = "UPDATE", # Change to your extension name
[string]$Configuration = "Release",
[string]$Version = "UPDATE", # Change to your version
[string[]]$Platforms = @("x64", "arm64")
)
$ErrorActionPreference = "Stop"
Write-Host "Building $ExtensionName EXE installer..." -ForegroundColor Green
Write-Host "Version: $Version" -ForegroundColor Yellow
Write-Host "Platforms: $($Platforms -join ', ')" -ForegroundColor Yellow
# Get the project directory (two levels up from winget-resources)
$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
$ProjectDir = Split-Path -Parent (Split-Path -Parent $ScriptDir)
$ProjectFile = "$ProjectDir\$ExtensionName.csproj"
Write-Host "Script directory: $ScriptDir" -ForegroundColor Cyan
Write-Host "Project directory: $ProjectDir" -ForegroundColor Cyan
# Clean previous builds
Write-Host "Cleaning previous builds..." -ForegroundColor Yellow
if (Test-Path "$ProjectDir\bin") {
Remove-Item -Path "$ProjectDir\bin" -Recurse -Force -ErrorAction SilentlyContinue
}
if (Test-Path "$ProjectDir\obj") {
Remove-Item -Path "$ProjectDir\obj" -Recurse -Force -ErrorAction SilentlyContinue
}
# Restore packages
Write-Host "Restoring NuGet packages..." -ForegroundColor Yellow
dotnet restore $ProjectFile
# Build for each platform
foreach ($Platform in $Platforms) {
Write-Host "`n=== Building $Platform ===" -ForegroundColor Cyan
# Build and publish
Write-Host "Building and publishing $Platform application..." -ForegroundColor Yellow
dotnet publish $ProjectFile `
--configuration $Configuration `
--runtime "win-$Platform" `
--self-contained true `
--output "$ProjectDir\bin\$Configuration\win-$Platform\publish"
if ($LASTEXITCODE -ne 0) {
Write-Warning "Build failed for $Platform with exit code: $LASTEXITCODE"
continue
}
# Check if files were published
$publishDir = "$ProjectDir\bin\$Configuration\win-$Platform\publish"
$fileCount = (Get-ChildItem -Path $publishDir -Recurse -File).Count
Write-Host "✅ Published $fileCount files to $publishDir" -ForegroundColor Green
# Create platform-specific setup script
Write-Host "Creating installer script for $Platform..." -ForegroundColor Yellow
$setupTemplate = Get-Content "$ScriptDir\setup-template.iss" -Raw
# Update version
$setupScript = $setupTemplate -replace '#define AppVersion ".*"', "#define AppVersion `"$Version`""
# Update output filename to include platform suffix
$setupScript = $setupScript -replace 'OutputBaseFilename=(.*?)\{#AppVersion\}', "OutputBaseFilename=`$1{#AppVersion}-$Platform"
# Update source path for the platform
$setupScript = $setupScript -replace 'Source: "bin\\Release\\win-x64\\publish', "Source: `"bin\Release\win-$Platform\publish"
# Add architecture settings after [Setup] section
if ($Platform -eq "arm64") {
$setupScript = $setupScript -replace '(\[Setup\][^\[]*)(MinVersion=)', "`$1ArchitecturesAllowed=arm64`r`nArchitecturesInstallIn64BitMode=arm64`r`n`$2"
} else {
$setupScript = $setupScript -replace '(\[Setup\][^\[]*)(MinVersion=)', "`$1ArchitecturesAllowed=x64compatible`r`nArchitecturesInstallIn64BitMode=x64compatible`r`n`$2"
}
$setupScript | Out-File -FilePath "$ProjectDir\setup-$Platform.iss" -Encoding UTF8
# Create installer with Inno Setup
Write-Host "Creating $Platform installer with Inno Setup..." -ForegroundColor Yellow
$InnoSetupPath = "${env:ProgramFiles(x86)}\Inno Setup 6\iscc.exe"
if (-not (Test-Path $InnoSetupPath)) {
$InnoSetupPath = "${env:ProgramFiles}\Inno Setup 6\iscc.exe"
}
if (Test-Path $InnoSetupPath) {
& $InnoSetupPath "$ProjectDir\setup-$Platform.iss"
if ($LASTEXITCODE -eq 0) {
$installer = Get-ChildItem "$ProjectDir\bin\$Configuration\installer\*-$Platform.exe" -ErrorAction SilentlyContinue | Select-Object -First 1
if ($installer) {
$sizeMB = [math]::Round($installer.Length / 1MB, 2)
Write-Host "✅ Created $Platform installer: $($installer.Name) ($sizeMB MB)" -ForegroundColor Green
} else {
Write-Warning "Installer file not found for $Platform"
}
} else {
Write-Warning "Inno Setup failed for $Platform with exit code: $LASTEXITCODE"
}
} else {
Write-Warning "Inno Setup not found at expected locations"
}
}
Write-Host "`n🎉 Build completed successfully!" -ForegroundColor Green

View File

@@ -0,0 +1,127 @@
# TEMPLATE: Extension EXE Installer Build and Release Workflow
#
# To use this template for a new extension:
# 1. Copy this file to a new workflow file (e.g., release-extension-exe.yml)
# 2. Update Global constants with your data:
# - GITHUB_REPO_URL with your GitHub repository URL (e.g., https://github.com/yourusername/YourRepository)
# - DISPLAY_NAME with your display name (e.g., My Extension)
# - EXTENSION_NAME with your extension name (e.g., CmdPalMyExtension)
# - FOLDER_NAME with your project folder name (e.g., CmdPalMyExtension)
name: CmdPal Extension - Build EXE Installer
on:
workflow_dispatch:
inputs:
version:
description: 'Version number (leave empty to auto-detect)'
required: false
type: string
release_notes:
description: 'What is new in this version'
required: false
default: 'New release with latest updates and improvements.'
type: string
# Global constants: UPDATE THESE, example; DISPLAY_NAME: ${{ vars.DISPLAY_NAME || 'CmdPal Name' }}
env:
DISPLAY_NAME: ${{ vars.DISPLAY_NAME || 'DISPLAY_NAME' }}
EXTENSION_NAME: ${{ vars.EXTENSION_NAME || 'EXTENSION_NAME' }}
FOLDER_NAME: ${{ vars.FOLDER_NAME || 'FOLDER_NAME' }}
GITHUB_REPO_URL: ${{ vars.GITHUB_REPO_URL || 'GITHUB_REPO_URL' }}
jobs:
build:
runs-on: windows-2022
permissions:
contents: write
actions: read
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup .NET 9
uses: actions/setup-dotnet@v4
with:
dotnet-version: '9.0.x'
- name: Install Inno Setup
run: choco install innosetup -y --no-progress
shell: pwsh
- name: Get version from project
id: version
run: |
if ("${{ github.event.inputs.version }}" -ne "") {
$version = "${{ github.event.inputs.version }}"
} else {
$projectFile = "${{ env.FOLDER_NAME }}/${{ env.EXTENSION_NAME }}.csproj"
$xml = [xml](Get-Content $projectFile)
$version = $xml.Project.PropertyGroup.AppxPackageVersion | Select-Object -First 1
if (-not $version) { throw "Version not found in project file" }
}
echo "VERSION=$version" >> $env:GITHUB_OUTPUT
Write-Host "Using version: $version"
shell: pwsh
- name: Build EXE installers (x64 and ARM64)
run: |
Set-Location "${{ env.FOLDER_NAME }}/Publication/winget-resources"
.\build-exe.ps1 -Version "${{ steps.version.outputs.VERSION }}" -Platforms @("x64", "arm64")
shell: pwsh
- name: Upload x64 installer artifact
uses: actions/upload-artifact@v4
with:
name: ${{ env.EXTENSION_NAME }}-x64-installer
path: ${{ env.FOLDER_NAME }}/bin/Release/installer/*-x64.exe
if-no-files-found: error
- name: Upload ARM64 installer artifact
uses: actions/upload-artifact@v4
with:
name: ${{ env.EXTENSION_NAME }}-arm64-installer
path: ${{ env.FOLDER_NAME }}/bin/Release/installer/*-arm64.exe
if-no-files-found: warn
- name: Create GitHub Release
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ env.EXTENSION_NAME }}-v${{ steps.version.outputs.VERSION }}
name: "${{ env.DISPLAY_NAME }} v${{ steps.version.outputs.VERSION }}"
body: |
## 🎯 ${{ env.DISPLAY_NAME }} ${{ steps.version.outputs.VERSION }}
## What's New
${{ github.event.inputs.release_notes }}
## 📦 Installation
Download the installer for your system architecture:
- **x64 (Intel/AMD)**: `${{ env.DISPLAY_NAME }}-Setup-${{ steps.version.outputs.VERSION }}-x64.exe`
- **ARM64 (Windows on ARM)**: `${{ env.DISPLAY_NAME }}-Setup-${{ steps.version.outputs.VERSION }}-arm64.exe`
1. Download the appropriate installer from the Assets section below
2. Run the installer with administrator privileges
3. The extension will be registered and available in Command Palette
## 🔗 More Information
Repository: ${{ env.GITHUB_REPO_URL }}
files: ${{ env.FOLDER_NAME }}/bin/Release/installer/*.exe
draft: false
prerelease: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Build summary
run: |
Write-Host "🎉 ${{ env.DISPLAY_NAME }} Release Complete!" -ForegroundColor Green
Write-Host "Version: ${{ steps.version.outputs.VERSION }}" -ForegroundColor Yellow
Write-Host "📁 Installer uploaded to GitHub Release" -ForegroundColor Green
shell: pwsh

View File

@@ -0,0 +1,36 @@
; TEMPLATE: Inno Setup Script for Command Palette Extensions
;
; To use this template for a new extension:
; 1. Copy this file to your extension's project folder as "setup-template.iss"
; 2. Replace EXTENSION_NAME with your extension name (e.g., CmdPalMyExtension)
; 3. Replace DISPLAY_NAME with your extension's display name (e.g., My Extension)
; 4. Replace DEVELOPER_NAME with your name (e.g., Your Name Here)
; 5. Replace CLSID-HERE with extensions CLSID
; 6. Update the default version to match your project file
#define AppVersion "0.0.1.0"
[Setup]
AppId={{GUID-HERE}}
AppName=DISPLAY_NAME
AppVersion={#AppVersion}
AppPublisher=DEVELOPER_NAME
DefaultDirName={autopf}\EXTENSION_NAME
OutputDir=bin\Release\installer
OutputBaseFilename=EXTENSION_NAME-Setup-{#AppVersion}
Compression=lzma
SolidCompression=yes
MinVersion=10.0.19041
[Languages]
Name: "english"; MessagesFile: "compiler:Default.isl"
[Files]
Source: "bin\Release\win-x64\publish\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs
[Icons]
Name: "{group}\DISPLAY_NAME"; Filename: "{app}\EXTENSION_NAME.exe"
[Registry]
Root: HKCU; Subkey: "SOFTWARE\Classes\CLSID\{{CLSID-HERE}}"; ValueData: "EXTENSION_NAME"
Root: HKCU; Subkey: "SOFTWARE\Classes\CLSID\{{CLSID-HERE}}\LocalServer32"; ValueData: "{app}\EXTENSION_NAME.exe -RegisterProcessAsComServer"

View File

@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>WinExe</OutputType>
<RootNamespace>TemplateCmdPalExtension</RootNamespace>
@@ -10,20 +10,58 @@
<SupportedOSPlatformVersion>10.0.19041.0</SupportedOSPlatformVersion>
<RuntimeIdentifiers>win-x64;win-arm64</RuntimeIdentifiers>
<PublishProfile>win-$(Platform).pubxml</PublishProfile>
<EnableMsixTooling>true</EnableMsixTooling>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<Content Include="Assets\SplashScreen.scale-200.png" />
<Content Include="Assets\LockScreenLogo.scale-200.png" />
<Content Include="Assets\Square150x150Logo.scale-200.png" />
<Content Include="Assets\Square44x44Logo.scale-200.png" />
<Content Include="Assets\Square44x44Logo.targetsize-24_altform-unplated.png" />
<Content Include="Assets\StoreLogo.png" />
<Content Include="Assets\Wide310x150Logo.scale-200.png" />
<Content Include="Assets\**\*.png" />
</ItemGroup>
<PropertyGroup>
<!-- FOR PUBLISHING TO WINGET -->
<!-- When you're ready to publish your extension to winget,
comment out PublishProfile and uncomment WindowsPackageType tag to create
OR USE THE GITHUB ACTION TO DO THIS FOR YOU-->
<PublishProfile>win-$(Platform).pubxml</PublishProfile>
<!--<WindowsPackageType>None</WindowsPackageType> -->
<!-- FOR PUBLISHING TO MICROSOFT STORE 1 of 2-->
<!-- When you're ready to publish your extension to Microsoft Store, you'll need to change that are below
AppxPackageIdentityName = replace with Microsoft Store's Package/Identity/Name
AppxPackagePublisher = replace with Microsoft Store's Package/Identity/Publisher
-->
<!-- <AppxPackageIdentityName>YOUR_PACKAGE_IDENTITY_NAME_HERE</AppxPackageIdentityName>
<AppxPackagePublisher>YOUR_PACKAGE_IDENTITY_PUBLISHER_HERE</AppxPackagePublisher>
<AppxPackageVersion>0.0.1.0</AppxPackageVersion> -->
</PropertyGroup>
<!-- FOR PUBLISHING TO MICROSOFT STORE 2 of 2-->
<!-- When you're ready to publish your extension to Microsoft Store, uncomment the
Target tag and confirm the images exist -->
<!-- <Target Name="PrepareAssets" BeforeTargets="BeforeBuild">
<Copy SourceFiles="$(MSBuildProjectDirectory)\Assets\Square150x150Logo.scale-200.png"
DestinationFiles="$(MSBuildProjectDirectory)\Assets\Square150x150Logo.png"
SkipUnchangedFiles="true" />
<Copy SourceFiles="$(MSBuildProjectDirectory)\Assets\Square44x44Logo.scale-200.png"
DestinationFiles="$(MSBuildProjectDirectory)\Assets\SmallTile.png"
SkipUnchangedFiles="true" />
<Copy SourceFiles="$(MSBuildProjectDirectory)\Assets\Wide310x150Logo.scale-200.png"
DestinationFiles="$(MSBuildProjectDirectory)\Assets\Wide310x150Logo.png"
SkipUnchangedFiles="true" />
<Copy SourceFiles="$(MSBuildProjectDirectory)\Assets\SplashScreen.scale-200.png"
DestinationFiles="$(MSBuildProjectDirectory)\Assets\SplashScreen.png"
SkipUnchangedFiles="true" />
<Copy SourceFiles="$(MSBuildProjectDirectory)\Assets\Square150x150Logo.scale-200.png"
DestinationFiles="$(MSBuildProjectDirectory)\Assets\LargeTile.png"
SkipUnchangedFiles="true" />
<Copy SourceFiles="$(MSBuildProjectDirectory)\Assets\StoreLogo.scale-100.png"
DestinationFiles="$(MSBuildProjectDirectory)\Assets\StoreLogo.png"
SkipUnchangedFiles="true" />
</Target> -->
<ItemGroup>
<Manifest Include="$(ApplicationManifest)" />