Files
terminal-microsoft/build/scripts/New-UnpackagedTerminalDistribution.ps1

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

151 lines
5.5 KiB
PowerShell
Raw Normal View History

[CmdletBinding(DefaultParameterSetName = 'AppX')]
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
Param(
[Parameter(Mandatory, HelpMessage="Path to Terminal AppX", ParameterSetName = 'AppX')]
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
[ValidateScript({Test-Path $_ -Type Leaf})]
[string]
$TerminalAppX,
[Parameter(Mandatory, HelpMessage="Path to Terminal Layout Deployment", ParameterSetName='Layout')]
[ValidateScript({Test-Path $_ -Type Container})]
[string]
$TerminalLayout,
[Parameter(Mandatory, HelpMessage="Path to Xaml AppX", ParameterSetName='AppX')]
[Parameter(Mandatory, HelpMessage="Path to Xaml AppX", ParameterSetName='Layout')]
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
[ValidateScript({Test-Path $_ -Type Leaf})]
[string]
$XamlAppX,
[Parameter(HelpMessage="Output Directory", ParameterSetName='AppX')]
[Parameter(HelpMessage="Output Directory", ParameterSetName='Layout')]
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
[string]
$Destination = ".",
[Parameter(HelpMessage="Path to makeappx.exe", ParameterSetName='AppX')]
[Parameter(HelpMessage="Path to makeappx.exe", ParameterSetName='Layout')]
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
[ValidateScript({Test-Path $_ -Type Leaf})]
[string]
$MakeAppxPath = "C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64\MakeAppx.exe",
[Parameter(HelpMessage="Include the portable mode marker file by default", ParameterSetName='AppX')]
[Parameter(HelpMessage="Include the portable mode marker file by default", ParameterSetName='Layout')]
[switch]
$PortableMode = $PSCmdlet.ParameterSetName -eq 'Layout'
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
)
$filesToRemove = @("*.xml", "*.winmd", "Appx*", "Images/*Tile*", "Images/*Logo*") # Remove from Terminal
$filesToKeep = @() # ... except for these
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
$filesToCopyFromXaml = @("Microsoft.UI.Xaml.dll", "Microsoft.UI.Xaml") # We don't need the .winmd
$ErrorActionPreference = 'Stop'
If ($null -Eq (Get-Item $MakeAppxPath -EA:SilentlyContinue)) {
Write-Error "Could not find MakeAppx.exe at `"$MakeAppxPath`".`nMake sure that -MakeAppxPath points to a valid SDK."
Exit 1
}
$tempDir = Join-Path ([System.IO.Path]::GetTempPath()) "tmp$([Convert]::ToString((Get-Random 65535),16).PadLeft(4,'0')).tmp"
New-Item -ItemType Directory -Path $tempDir | Out-Null
$XamlAppX = Get-Item $XamlAppX | Select-Object -Expand FullName
########
# Reading the AppX Manifest for preliminary info
########
If ($TerminalAppX) {
$appxManifestPath = Join-Path $tempDir AppxManifest.xml
& tar.exe -x -f "$TerminalAppX" -C $tempDir AppxManifest.xml
} ElseIf($TerminalLayout) {
$appxManifestPath = Join-Path $TerminalLayout AppxManifest.xml
}
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
$manifest = [xml](Get-Content $appxManifestPath)
$pfn = $manifest.Package.Identity.Name
$version = $manifest.Package.Identity.Version
$architecture = $manifest.Package.Identity.ProcessorArchitecture
$distributionName = "{0}_{1}_{2}" -f ($pfn, $version, $architecture)
$terminalDir = "terminal-{0}" -f ($version)
########
# Unpacking Terminal and XAML
########
$terminalAppPath = Join-Path $tempdir $terminalDir
If ($TerminalAppX) {
$TerminalAppX = Get-Item $TerminalAppX | Select-Object -Expand FullName
New-Item -ItemType Directory -Path $terminalAppPath | Out-Null
& $MakeAppxPath unpack /p $TerminalAppX /d $terminalAppPath /o | Out-Null
If ($LASTEXITCODE -Ne 0) {
Throw "Unpacking $TerminalAppX failed"
}
} ElseIf ($TerminalLayout) {
Copy-Item -Recurse -Path $TerminalLayout -Destination $terminalAppPath
}
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
$xamlAppPath = Join-Path $tempdir "xaml"
New-Item -ItemType Directory -Path $xamlAppPath | Out-Null
& $MakeAppxPath unpack /p $XamlAppX /d $xamlAppPath /o | Out-Null
If ($LASTEXITCODE -Ne 0) {
Throw "Unpacking $XamlAppX failed"
}
########
# Some sanity checking
########
$xamlManifest = [xml](Get-Content (Join-Path $xamlAppPath "AppxManifest.xml"))
If ($xamlManifest.Package.Identity.Name -NotLike "Microsoft.UI.Xaml*") {
Throw "$XamlAppX is not a XAML package (instead, it looks like $($xamlManifest.Package.Identity.Name))"
}
If ($xamlManifest.Package.Identity.ProcessorArchitecture -Ne $architecture) {
Throw "$XamlAppX is not built for $architecture (instead, it is built for $($xamlManifest.Package.Identity.ProcessorArchitecture))"
}
########
# Preparation of source files
########
$itemsToRemove = $filesToRemove | ForEach-Object {
Get-Item (Join-Path $terminalAppPath $_) -EA:SilentlyContinue | Where-Object {
$filesToKeep -NotContains $_.Name
}
} | Sort-Object FullName -Unique
$itemsToRemove | Remove-Item -Recurse
$filesToCopyFromXaml | ForEach-Object {
Get-Item (Join-Path $xamlAppPath $_)
} | Copy-Item -Recurse -Destination $terminalAppPath
########
# Resource Management
########
$finalTerminalPriFile = Join-Path $terminalAppPath "resources.pri"
& (Join-Path $PSScriptRoot "Merge-TerminalAndXamlResources.ps1") `
-TerminalRoot $terminalAppPath `
-XamlRoot $xamlAppPath `
-OutputPath $finalTerminalPriFile `
-Verbose:$Verbose | Out-Host
Add support for an unpackaged distribution of Terminal (#15034) Since the removal of the Win10-specific variant of the Terminal MSIX in #15031, there has been no officially-sanctioned (or even unofficially tested!) way to get an unzippable double-click-runnable version of Windows Terminal. Due to a quirk in the resource loading system, an unpackaged distribution of Terminal needs to ship all of XAML's resources and all of is own resources in a single `resources.pri` file. The tooling to support this is minimal, and we were previously just coasting by on Visual Studio's generosity plus how the prerelease distribution of XAML embedded itself into the consuming package. This pull request introduces a build phase plus a supporting script (or three) that produces a ZIP file distribution of Windows Terminal when given a Terminal MSIX and an XAML AppX. The three scripts are: 1. A script to merge any number of PRI files and/or PRI dump files (made with `makepri dump /dt detailed`) 2. A script that specifically merges XAML's resources with Terminal's. This is necessary because the XAML package emits a couple PRI resources into Terminal's resources _even when it is not co-packaged._ We need to remove the conflicting resources. 3. Finally, a script to take a WT and XAML distribution and combine them -- resources, files, everything -- and strip out the things that we don't need. This script is an all-in-one that calls the other two and produces a ZIP file at the end. The final distribution is named after the PFN (`Microsoft.WindowsTerminal`, or `...Preview` or `WindowsTerminalDev`), the version number and the architecture. When expanded, it produces a directory named `terminal-X.Y.Z.A` (version number.) I've also added the build script to the release pipeline. As a treat, this also produces an unpackaged distribution out of every CI build... that way, contributors can download live deployable copies of WT Unpackaged to test out their changes. Pretty cool. Refs #1386
2023-03-30 16:38:10 -05:00
########
# Packaging
########
$portableModeMarkerFile = Join-Path $terminalAppPath ".portable"
If ($PortableMode) {
"" | Out-File $portableModeMarkerFile
}
If ($PSCmdlet.ParameterSetName -Eq "AppX") {
# We only produce a ZIP when we're combining two AppX directories.
New-Item -ItemType Directory -Path $Destination -ErrorAction:SilentlyContinue | Out-Null
$outputZip = (Join-Path $Destination ("{0}.zip" -f ($distributionName)))
& tar -c --format=zip -f $outputZip -C $tempDir $terminalDir
Remove-Item -Recurse -Force $tempDir -EA:SilentlyContinue
Get-Item $outputZip
} ElseIf ($PSCmdlet.ParameterSetName -Eq "Layout") {
Get-Item $terminalAppPath
}