mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-05 18:57:19 +02:00
This pull request refactors and standardizes the PowerToys build scripts to improve maintainability, reusability, and platform detection. The main changes are the introduction of a shared helper script (`build-common.ps1`), migration of build logic in individual scripts to use these helpers, and enhanced platform auto-detection. This makes the build pipeline more robust and easier to use from any directory within the repository. As the result of our recent changes, use the following guidance when working in the PowerToys repo: 1. Use `build-essentials.ps1` before any development in general - Purpose: restore NuGet packages for the full solution and build a small set of essential native projects (runner, settings). This is a fast way to ensure native artifacts required for local development are available. 2. Use `build.ps1` from any folder - Purpose: lightweight local builder. It auto-discovers the target platform (x64/arm64/x86) and builds projects it finds in the current directory. - Notes: you can pass additional MSBuild arguments positionally (e.g. `./tools/build/build.ps1 '/p:CIBuild=true'`) — the script will forward them to MSBuild. - Use `-RestoreOnly` to only restore packages for local projects. 3. Use `build-installer.ps1` to create a local installer (use with caution) - Purpose: runs the full pipeline that restores, builds the full solution, signs packages, and builds the installer (MSI/bootstrapper). - Caution: this script performs cleaning (git clean) and installer packaging steps that may remove untracked files under `installer/`. Additional notes - Shared helpers live in `build-common.ps1` and are used by the other scripts (`RunMSBuild`, `RestoreThenBuild`, `BuildProjectsInDirectory`, platform auto-detection). **Shared build logic and helper functions:** * Added new `tools/build/build-common.ps1` file containing reusable PowerShell functions for MSBuild invocation, solution/project restore and build, platform detection, and project discovery. All build scripts now dot-source this file for shared functionality. **Refactoring of build scripts to use shared helpers:** * Updated `tools/build/build-essentials.ps1` to use `build-common.ps1` helpers, including auto-detection of repository root and platform, and simplified project build logic. * Created new `tools/build/build.ps1` for quick local builds, using shared helpers and supporting extra MSBuild arguments and platform auto-detection. * Refactored `tools/build/build-installer.ps1` to remove duplicate build logic, use shared helpers, and support platform auto-detection and argument forwarding. [[1]](diffhunk://#diff-21888769485d767c43c0895fe315e6f6d7384da62f60ef917d8a61a610da10b9L55-R74) [[2]](diffhunk://#diff-21888769485d767c43c0895fe315e6f6d7384da62f60ef917d8a61a610da10b9L83-L126) **Improved platform detection and argument handling:** * All scripts now auto-detect the target platform if not specified, using the new `Get-DefaultPlatform` helper. This supports x64, arm64, and x86 hosts. [[1]](diffhunk://#diff-43764921d6c830dbb3a15fe875aebfbc46966ae5ff62f3179adb3ff046b47b9dR1-R166) [[2]](diffhunk://#diff-946ed85e16779fdbcfeb7de80f631eae2da0f7bd478e27e22621121b409dde88L1-R70) [[3]](diffhunk://#diff-7a444242b2a6d9c642341bd2ef45f51ba5698ad7827e5136e85eb483863967a7R1-R88) [[4]](diffhunk://#diff-21888769485d767c43c0895fe315e6f6d7384da62f60ef917d8a61a610da10b9L55-R74) **Consistent MSBuild invocation and logging:** * MSBuild calls now consistently use shared helpers, centralized logging, and support passing extra arguments such as `/p:CIBuild=true` and custom solution/project paths. [[1]](diffhunk://#diff-43764921d6c830dbb3a15fe875aebfbc46966ae5ff62f3179adb3ff046b47b9dR1-R166) [[2]](diffhunk://#diff-21888769485d767c43c0895fe315e6f6d7384da62f60ef917d8a61a610da10b9L137-R110) [[3]](diffhunk://#diff-21888769485d767c43c0895fe315e6f6d7384da62f60ef917d8a61a610da10b9L151-R125) [[4]](diffhunk://#diff-21888769485d767c43c0895fe315e6f6d7384da62f60ef917d8a61a610da10b9L162-R139) **Project and solution build improvements:** * Build scripts now discover and build projects in preferred order (.sln, .csproj, .vcxproj), and support restoring packages only if requested. [[1]](diffhunk://#diff-43764921d6c830dbb3a15fe875aebfbc46966ae5ff62f3179adb3ff046b47b9dR1-R166) [[2]](diffhunk://#diff-7a444242b2a6d9c642341bd2ef45f51ba5698ad7827e5136e85eb483863967a7R1-R88) Let me know if you need a walkthrough of the new helper functions or how to use the updated build scripts!
89 lines
3.3 KiB
PowerShell
89 lines
3.3 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Light-weight wrapper to build local projects (solutions/projects) in the current working directory using helpers in build-common.ps1.
|
|
|
|
.DESCRIPTION
|
|
This script is intended for quick local builds. It dot-sources `build-common.ps1` and calls `BuildProjectsInDirectory` against the current directory. Use `-RestoreOnly` to only restore packages for local projects. If `-Platform` is omitted the script attempts to auto-detect the host platform.
|
|
|
|
.PARAMETER Platform
|
|
Target platform (e.g., 'x64', 'arm64'). If omitted the script will try to detect the host platform automatically.
|
|
|
|
.PARAMETER Configuration
|
|
Build configuration (e.g., 'Debug', 'Release'). Default: 'Debug'.
|
|
|
|
.PARAMETER RestoreOnly
|
|
If specified, only perform package restore for local projects and skip the build steps for a solution file (i.e. .sln).
|
|
|
|
.PARAMETER ExtraArgs
|
|
Any remaining, positional arguments passed to the script are forwarded to MSBuild as additional arguments (e.g., '/p:CIBuild=true').
|
|
|
|
.EXAMPLE
|
|
.\tools\build\build.ps1
|
|
Builds any .sln/.csproj/.vcxproj in the current working directory (auto-detects Platform).
|
|
|
|
.EXAMPLE
|
|
.\tools\build\build.ps1 -Platform x64 -Configuration Release
|
|
Builds local projects for x64 Release.
|
|
|
|
.EXAMPLE
|
|
.\tools\build\build.ps1 '/p:CIBuild=true' '/p:SomeOther=Value'
|
|
Pass additional MSBuild arguments; these are forwarded to the underlying msbuild calls.
|
|
|
|
.EXAMPLE
|
|
.\tools\build\build.ps1 -RestoreOnly '/p:CIBuild=true'
|
|
Only restores packages for local projects; ExtraArgs still forwarded to msbuild's restore phase.
|
|
|
|
.NOTES
|
|
- This file expects `build-common.ps1` to be located in the same folder and dot-sources it to load helper functions.
|
|
- ExtraArgs are captured using PowerShell's ValueFromRemainingArguments and joined before being passed to the helpers.
|
|
#>
|
|
|
|
param (
|
|
[string]$Platform = '',
|
|
[string]$Configuration = 'Debug',
|
|
[switch]$RestoreOnly,
|
|
[Parameter(ValueFromRemainingArguments=$true)]
|
|
[string[]]$ExtraArgs
|
|
)
|
|
|
|
. "$PSScriptRoot\build-common.ps1"
|
|
|
|
# If user passed MSBuild-style args (e.g. './build.ps1 /p:CIBuild=true'),
|
|
# those will bind to $Platform/$Configuration; detect those and move them to ExtraArgs.
|
|
$positionalExtra = @()
|
|
if ($Platform -and $Platform -match '^[\/-]') {
|
|
$positionalExtra += $Platform
|
|
$Platform = ''
|
|
}
|
|
if ($Configuration -and $Configuration -match '^[\/-]') {
|
|
$positionalExtra += $Configuration
|
|
$Configuration = 'Debug'
|
|
}
|
|
if ($positionalExtra.Count -gt 0) {
|
|
if (-not $ExtraArgs) { $ExtraArgs = @() }
|
|
$ExtraArgs = $positionalExtra + $ExtraArgs
|
|
}
|
|
|
|
# Auto-detect platform when not provided
|
|
if (-not $Platform -or $Platform -eq '') {
|
|
try {
|
|
$Platform = Get-DefaultPlatform
|
|
Write-Host ("[AUTO-PLATFORM] Detected platform: {0}" -f $Platform)
|
|
} catch {
|
|
Write-Warning "Failed to auto-detect platform; defaulting to x64"
|
|
$Platform = 'x64'
|
|
}
|
|
}
|
|
|
|
$cwd = (Get-Location).ProviderPath
|
|
$extraArgsString = $null
|
|
if ($ExtraArgs -and $ExtraArgs.Count -gt 0) { $extraArgsString = ($ExtraArgs -join ' ') }
|
|
|
|
if (BuildProjectsInDirectory -DirectoryPath $cwd -ExtraArgs $extraArgsString -Platform $Platform -Configuration $Configuration -RestoreOnly:$RestoreOnly) {
|
|
Write-Host "[BUILD] Local projects built; exiting."
|
|
exit 0
|
|
} else {
|
|
Write-Host "[BUILD] No local projects found in $cwd"
|
|
exit 0
|
|
}
|