Skip to content

make macOS package use a consistent path #7006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TravisEz13 merged 3 commits into from
Jun 6, 2018
Merged

make macOS package use a consistent path #7006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4572f56
change the package template to make the product id a placeholder
TravisEz13 Jun 5, 2018
8f32860
fix utime workaround to work when it requires sudo
TravisEz13 Jun 5, 2018
a8665e8
make path on macOS be /usr/local/microsoft/powershell/6 for stable re…
TravisEz13 Jun 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 65 additions & 11 deletions tools/packaging/packaging.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ function Start-PSPackage {

[Switch] $Force,

[Switch] $SkipReleaseChecks
[Switch] $SkipReleaseChecks,

[switch] $NoSudo
)

DynamicParam {
Expand Down Expand Up @@ -318,6 +320,7 @@ function Start-PSPackage {
Name = $Name
Version = $Version
Force = $Force
NoSudo = $NoSudo
}
foreach ($Distro in $Script:DebianDistributions) {
$Arguments["Distribution"] = $Distro
Expand All @@ -333,6 +336,7 @@ function Start-PSPackage {
Name = $Name
Version = $Version
Force = $Force
NoSudo = $NoSudo
}

if ($PSCmdlet.ShouldProcess("Create $_ Package")) {
Expand Down Expand Up @@ -534,7 +538,10 @@ function New-UnixPackage {
[string]$Iteration = "1",

[Switch]
$Force
$Force,

[switch]
$NoSudo
)

DynamicParam {
Expand All @@ -555,6 +562,10 @@ function New-UnixPackage {
}

End {
# This allows sudo install to be optional; needed when running in containers / as root
# Note that when it is null, Invoke-Expression (but not &) must be used to interpolate properly
$sudo = if (!$NoSudo) { "sudo" }

# Validate platform
$ErrorMessage = "Must be on {0} to build '$Type' packages!"
switch ($Type) {
Expand Down Expand Up @@ -601,7 +612,7 @@ function New-UnixPackage {
}

# Determine if the version is a preview version
$IsPreview = $Version.Contains("-preview")
$IsPreview = Test-IsPreview -Version $Version

# Preview versions have preview in the name
$Name = if ($IsPreview) { "powershell-preview" } else { "powershell" }
Expand Down Expand Up @@ -655,7 +666,7 @@ function New-UnixPackage {
if ($Environment.IsMacOS) {
if (Test-Path $symlink_dest) {
Write-Warning "Move $symlink_dest to $hack_dest (fpm utime bug)"
Move-Item $symlink_dest $hack_dest
Start-NativeExecution ([ScriptBlock]::Create("$sudo mv $symlink_dest $hack_dest"))
}
}

Expand Down Expand Up @@ -723,7 +734,7 @@ function New-UnixPackage {
# this is continuation of a fpm hack for a weird bug
if (Test-Path $hack_dest) {
Write-Warning "Move $hack_dest to $symlink_dest (fpm utime bug)"
Move-Item $hack_dest $symlink_dest
Start-NativeExecution ([ScriptBlock]::Create("$sudo mv $hack_dest $symlink_dest"))
}
}
if ($AfterScriptInfo.AfterInstallScript) {
Expand All @@ -741,7 +752,7 @@ function New-UnixPackage {
if ($Environment.IsMacOS) {
if ($pscmdlet.ShouldProcess("Add distribution information and Fix PackageName"))
{
$createdPackage = New-MacOsDistributionPackage -FpmPackage $createdPackage
$createdPackage = New-MacOsDistributionPackage -FpmPackage $createdPackage -IsPreview:$IsPreview
}
}

Expand All @@ -761,7 +772,8 @@ function New-MacOsDistributionPackage
{
param(
[Parameter(Mandatory,HelpMessage='The FileInfo of the file created by FPM')]
[System.IO.FileInfo]$FpmPackage
[System.IO.FileInfo]$FpmPackage,
[Switch] $IsPreview
)

if(!$Environment.IsMacOS)
Expand Down Expand Up @@ -800,12 +812,15 @@ function New-MacOsDistributionPackage
# Create the distribution xml
$distributionXmlPath = Join-Path -Path $tempDir -ChildPath 'powershellDistribution.xml'

$packageId = Get-MacOSPackageId -IsPreview:$IsPreview.IsPresent

# format distribution template with:
# 0 - title
# 1 - version
# 2 - package path
# 2 - minimum os version
$PackagingStrings.OsxDistributionTemplate -f "PowerShell - $packageVersion", $packageVersion, $packageName, '10.12' | Out-File -Encoding ascii -FilePath $distributionXmlPath -Force
# 3 - minimum os version
# 4 - Package Identifier
$PackagingStrings.OsxDistributionTemplate -f "PowerShell - $packageVersion", $packageVersion, $packageName, '10.12', $packageId | Out-File -Encoding ascii -FilePath $distributionXmlPath -Force

Write-Log "Applying distribution.xml to package..."
Push-Location $tempDir
Expand Down Expand Up @@ -1086,13 +1101,34 @@ function New-ManGzip
ManFile = $ManFile
}
}

# Returns the macOS Package Identifier
function Get-MacOSPackageId
{
param(
[switch]
$IsPreview
)
if($IsPreview.IsPresent)
{
return 'com.microsoft.powershell-preview'
}
else
{
return 'com.microsoft.powershell'
}
}

function New-MacOSLauncher
{
param(
[Parameter(Mandatory)]
[String]$Version
)

$IsPreview = Test-IsPreview -Version $Version
$packageId = Get-MacOSPackageId -IsPreview:$IsPreview

# Define folder for launch application.
$macosapp = "$PSScriptRoot/macos/launcher/ROOT/Applications/Powershell.app"

Expand All @@ -1107,7 +1143,7 @@ function New-MacOSLauncher
# Set values in plist.
$plist = "$macosapp/Contents/Info.plist"
Start-NativeExecution {
defaults write $plist CFBundleIdentifier com.microsoft.powershell
defaults write $plist CFBundleIdentifier $packageId
defaults write $plist CFBundleVersion $Version
defaults write $plist CFBundleShortVersionString $Version
defaults write $plist CFBundleGetInfoString $Version
Expand Down Expand Up @@ -2212,6 +2248,24 @@ function New-MSIPatch
Remove-Item -Path $filesToCleanup -Force -Recurse -ErrorAction SilentlyContinue
}

<#
.Synopsis
Tests if a version is preview
.EXAMPLE
Test-IsPreview -version '6.1.0-sometthing' # returns true
Test-IsPreview -version '6.1.0' # returns false
#>
function Test-IsPreview
Copy link
Collaborator

@rjmholt rjmholt Jun 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only note here is that a string like "6.0.0-alpha.13-1557-gd67d87c" also passes this test. Just want to make sure that's intended behaviour (that string gets caught by the validation attribute so not a big concern).

Copy link
Member Author

@TravisEz13 TravisEz13 Jun 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an alpha would be considered a preview. basically anything with a dash (-) in the version is a preview.

{
param(
[parameter(Mandatory)]
[string]
$Version
)

return $Version -like '*-*'
}

<#
.Synopsis
Creates a Windows installer MSI package and assumes that the binaries are already built using 'Start-PSBuild'.
Expand Down Expand Up @@ -2283,7 +2337,7 @@ function New-MSIPackage

$ProductSemanticVersion = Get-PackageSemanticVersion -Version $ProductVersion
$simpleProductVersion = '6'
$isPreview = $ProductSemanticVersion -like '*-*'
$isPreview = Test-IsPreview -Version $ProductSemanticVersion
if($isPreview)
{
$simpleProductVersion += '-preview'
Expand Down
6 changes: 3 additions & 3 deletions tools/packaging/packaging.strings.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,17 @@ OsxDistributionTemplate = @'
<os-version min="{3}" />
</allowed-os-versions>
<options customize="never" require-scripts="false"/>
<product id="com.microsoft.powershell" version="{1}" />
<product id="{4}" version="{1}" />
<choices-outline>
<line choice="default">
<line choice="powershell"/>
</line>
</choices-outline>
<choice id="default"/>
<choice id="powershell" visible="false">
<pkg-ref id="com.microsoft.powershell"/>
<pkg-ref id="{4}"/>
</choice>
<pkg-ref id="com.microsoft.powershell" version="{1}" onConclusion="none">{2}</pkg-ref>
<pkg-ref id="{4}" version="{1}" onConclusion="none">{2}</pkg-ref>
</installer-gui-script>
'@
NuspecTemplate = @'
Expand Down