Build self-contained minimal size package for Guest Config team #14976

daxian-dbw · 2021-03-09T00:17:11Z

PR Summary

This PR includes changes in Build.psm1, packaging.psm1 and the release build template files.

For Build.psm1, -ForMinimalSize is added to Start-PSBuild to build self-contained application for "linux-x64", "win7-x64", or "osx-x64" runtimes. It reduces the size of package by:
- Avoid CrossGen PowerShell and all other library assemblies.
- Not include the Graphical Host and the WPF/WinForm stuff it pulls in.
- Remove symbol files (.pdb) and XML document files (.xml)
For packaging.psm1, min-size is added as a new value for -Type parameter of Start-PSPackage.
For Windows release build, a new build configuration minSize is added, to build and packaging the min-size package.
For Linux release build, -TarMinSize is added to PowerShellPackage.ps1 as well as build.json to build and package for the min-size package.

The min-size package has the -gc suffix to indicate that it's for the Guest Config team. In the Azure Blob, the min-size packages are uploaded to the container with the -gc suffix, not in the main package maintainer (e.g. v7-2-0-preview-4), so that they don't get uploaded to the GitHub release page.

Here is the release build run: https://dev.azure.com/mscodehub/PowerShellCore/_build/results?buildId=175764&view=results

The package size is reduced:

Windows (x64-zip): from 97mb to 45.3mb
Linux (x64-tar.gz): from 63.4mb to 40.6mb

PR Context

PR Checklist

adityapatwardhan · 2021-03-09T00:27:50Z

@daxian-dbw - seems like there are some merge conflicts. please have a look.

build.psm1

tools/packaging/packaging.psm1

tools/releaseBuild/Images/microsoft_powershell_windowsservercore/PowerShellPackage.ps1

rjmholt · 2021-03-09T00:41:36Z

tools/releaseBuild/Images/microsoft_powershell_windowsservercore/PowerShellPackage.ps1

+            $file = $_.FullName
+            Write-Verbose "Copying $file to $itemDestination" -Verbose
+            Copy-Item -Path $file -Destination "$itemDestination\" -Force
+            $projectAssetsCounter++


Where does this get used?

I'm not sure. This was existing code, see below:

PowerShell/tools/releaseBuild/Images/microsoft_powershell_windowsservercore/PowerShellPackage.ps1

Lines 173 to 186 in 877c97f

Write-Verbose "Exporting project.assets files ..." -Verbose

$projectAssetsCounter = 1

$projectAssetsFolder = Join-Path -Path $destination -ChildPath 'projectAssets'

$projectAssetsZip = Join-Path -Path $destination -ChildPath 'windowsProjectAssetssymbols.zip'

Get-ChildItem $location\project.assets.json -Recurse | ForEach-Object {

$subfolder = $_.FullName.Replace($location,'')

$subfolder.Replace('project.assets.json','')

$itemDestination = Join-Path -Path $projectAssetsFolder -ChildPath $subfolder

New-Item -Path $itemDestination -ItemType Directory -Force

$file = $_.FullName

Write-Verbose "Copying $file to $itemDestination" -Verbose

Copy-Item -Path $file -Destination "$itemDestination\" -Force

$projectAssetsCounter++

@TravisEz13, shall we remove $projectAssetsCounter?

build.psm1

adityapatwardhan · 2021-03-09T00:35:52Z

global.json

@@ -1,5 +1,5 @@
 {
  "sdk": {
-    "version": "6.0.100-preview.1.21104.4"


This should not change in this PR right?

The 21104.4 is not the official .NET 6 preview.1 SDK version. The nuget package versions are all correct, so this is the only place we need to change to make it use the official 6-preview.1 sdk.

tools/releaseBuild/Images/GenericLinuxFiles/PowerShellPackage.ps1

tools/releaseBuild/Images/microsoft_powershell_windowsservercore/PowerShellPackage.ps1

assets/wix/files.wxs

kilasuit · 2021-03-09T03:23:20Z

Would this PR address this issue #5681 ?

daxian-dbw · 2021-03-09T06:04:19Z

@kilasuit This is considered to be one step toward that goal, but doesn't resolve that issue. This package is produced mainly for using PowerShell in a service, where startup perf is not a concern (thus no R2R/Crossgen) and GUI won't work (thus no WPF/WinForm).

daxian-dbw · 2021-03-09T17:13:58Z

@adityapatwardhan and @rjmholt Thanks for the review! I have addressed or replied to your comments, please take another look.

Here is the new release build run: https://dev.azure.com/mscodehub/PowerShellCore/_build/results?buildId=175764&view=results

tools/releaseBuild/azureDevOps/templates/upload.yml

iSazonov · 2021-03-11T04:00:36Z

Avoid CrossGen PowerShell and all other library assemblies.

After that why do you build self-contained application? With shared framework you could significantly reduce a size of the packages.

tools/packaging/packaging.psm1

daxian-dbw · 2021-03-11T17:04:04Z

After that why do you build self-contained application? With shared framework you could significantly reduce a size of the packages.

This is a requirement from the Azure Guest Configuration service. There is no shared framework available and the service depends on PS package to bring in the .NET runtime.
For scenarios that have the shared framework available, the existing fx-depended packages can meet the needs.

anmenaga · 2021-03-12T01:30:43Z

@adityapatwardhan please take another look; thank you.

ghost · 2021-03-16T23:39:21Z

🎉v7.2.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

daxian-dbw requested review from rjmholt, TravisEz13, anmenaga and adityapatwardhan March 9, 2021 00:17

ghost assigned anmenaga Mar 9, 2021

daxian-dbw added 20 commits March 8, 2021 16:36

Avoid CrossGen and exclude GraphicHost from the build

b5ab2ae

Remove .pdb, .xml files; also remove the PSMaml schemas

204bb25

Integrate the min-size package to release build

c5751fc

Fix 'BuildConfiguration' name

6d7e5d6

Fix errors

f0092cb

Fix another error

e2c0912

Attempt to fix build

5c73fe3

Fix build break

29b36fa

Update file.wxs

aacbc71

Fix another build error

68b953a

Build min-size package for Linux

fd7ff3d

Upload the min-size package to separate container in Azure blob

6cde2f4

Do not upload min-size package to the main Az blob container

40c2702

Fix a typo

e7d6218

Updated linux.yml

5fa96ae

Fix the parsing error

290f88f

Fix the variable name

0f439d7

Fix min-size build for Linux

9c54468

Attempt to fix the linux min-size build

3c8805d

Update the log messages

7bb5ba2

rjmholt reviewed Mar 9, 2021

View reviewed changes

daxian-dbw force-pushed the size branch from d2b0cc2 to 7bb5ba2 Compare March 9, 2021 00:45

adityapatwardhan reviewed Mar 9, 2021

View reviewed changes

assets/wix/files.wxs Outdated Show resolved Hide resolved

Address comments

a8ed57d

rjmholt approved these changes Mar 9, 2021

View reviewed changes

TravisEz13 reviewed Mar 9, 2021

View reviewed changes

tools/releaseBuild/azureDevOps/templates/upload.yml Show resolved Hide resolved

TravisEz13 approved these changes Mar 9, 2021

View reviewed changes

Address more feedback

3335d09

iSazonov reviewed Mar 11, 2021

View reviewed changes

tools/packaging/packaging.psm1 Show resolved Hide resolved

TravisEz13 approved these changes Mar 11, 2021

View reviewed changes

adityapatwardhan approved these changes Mar 12, 2021

View reviewed changes

anmenaga added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Mar 12, 2021

anmenaga merged commit b636396 into PowerShell:master Mar 12, 2021

daxian-dbw deleted the size branch March 15, 2021 22:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build self-contained minimal size package for Guest Config team #14976

Build self-contained minimal size package for Guest Config team #14976

daxian-dbw commented Mar 9, 2021 •

edited

adityapatwardhan commented Mar 9, 2021

rjmholt Mar 9, 2021

daxian-dbw Mar 9, 2021

adityapatwardhan Mar 9, 2021

daxian-dbw Mar 9, 2021

kilasuit commented Mar 9, 2021

daxian-dbw commented Mar 9, 2021

daxian-dbw commented Mar 9, 2021 •

edited

iSazonov commented Mar 11, 2021

daxian-dbw commented Mar 11, 2021

anmenaga commented Mar 12, 2021

ghost commented Mar 16, 2021

	Write-Verbose "Exporting project.assets files ..." -Verbose

	$projectAssetsCounter = 1
	$projectAssetsFolder = Join-Path -Path $destination -ChildPath 'projectAssets'
	$projectAssetsZip = Join-Path -Path $destination -ChildPath 'windowsProjectAssetssymbols.zip'
	Get-ChildItem $location\project.assets.json -Recurse \| ForEach-Object {
	$subfolder = $_.FullName.Replace($location,'')
	$subfolder.Replace('project.assets.json','')
	$itemDestination = Join-Path -Path $projectAssetsFolder -ChildPath $subfolder
	New-Item -Path $itemDestination -ItemType Directory -Force
	$file = $_.FullName
	Write-Verbose "Copying $file to $itemDestination" -Verbose
	Copy-Item -Path $file -Destination "$itemDestination\" -Force
	$projectAssetsCounter++

Build self-contained minimal size package for Guest Config team #14976

Build self-contained minimal size package for Guest Config team #14976

Conversation

daxian-dbw commented Mar 9, 2021 • edited

PR Summary

PR Context

PR Checklist

adityapatwardhan commented Mar 9, 2021

rjmholt Mar 9, 2021

Choose a reason for hiding this comment

daxian-dbw Mar 9, 2021

Choose a reason for hiding this comment

adityapatwardhan Mar 9, 2021

Choose a reason for hiding this comment

daxian-dbw Mar 9, 2021

Choose a reason for hiding this comment

kilasuit commented Mar 9, 2021

daxian-dbw commented Mar 9, 2021

daxian-dbw commented Mar 9, 2021 • edited

iSazonov commented Mar 11, 2021

daxian-dbw commented Mar 11, 2021

anmenaga commented Mar 12, 2021

ghost commented Mar 16, 2021

daxian-dbw commented Mar 9, 2021 •

edited

daxian-dbw commented Mar 9, 2021 •

edited