use rcedit to embed icon and version information into pwsh.exe #5178

SteveL-MSFT · 2017-10-20T03:42:23Z

pwsh.exe today doesn't contain file version information and the icon is only associated with the shortcut file and not the exe

Fix is to use rcedit to embed:

icon
product version
file version
product name
copyright

Fix #2883
Fix #5166
Fix #5034

iSazonov · 2017-10-20T03:59:29Z

build.psm1

@@ -1862,6 +1862,18 @@ function New-MSIPackage
        [Switch] $Force
    )

+    ## need RCEdit to modify the binaries embedded resources
+    if (-not (Test-Path "~/.rcedit/rcedit-x64.exe"))


What about Unix?

I'm not as familiar on non-Windows with regards to viewing resources (which Explorer does easily), is this something I can do easily with Ubuntu? If so, I can move this to the build step rather than packaging.

Also rcedit only works on Windows

Get-Item <file> | fl * show ProductVersion on WSL.

@iSazonov not working for me with WSL:

PS /mnt/c/Windows/System32/WindowsPowerShell/v1.0> get-item ./powershell.exe | fl * PSPath : Microsoft.PowerShell.Core\FileSystem::/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe PSParentPath : Microsoft.PowerShell.Core\FileSystem::/mnt/c/Windows/System32/WindowsPowerShell/v1.0 PSChildName : powershell.exe PSDrive : / PSProvider : Microsoft.PowerShell.Core\FileSystem PSIsContainer : False Mode : --r--l VersionInfo : File: /mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe InternalName: OriginalFilename: FileVersion: FileDescription: Product: ProductVersion:

It looks like PowerShell is simply using the FileVersionInfo class which doesn't return anything on Linux:

PS /mnt/c/Windows/System32/WindowsPowerShell/v1.0> [System.Diagnostics.FileVersionInfo]::GetVersionInfo("/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe") ProductVersion FileVersion FileName -------------- ----------- -------- /mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe

but on Windows:

PS C:\Windows\System32\WindowsPowerShell\v1.0> [System.Diagnostics.FileVersionInfo]::GetVersionInfo("C:\Windows\system32 \WindowsPowerShell\v1.0\powershell.exe") ProductVersion FileVersion FileName -------------- ----------- -------- 10.0.17019.1000 10.0.17019.10... C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe

Linux ELF binaries probably don't have a resource section to stuff this info into.

@SteveL-MSFT Why you test the Windows FullCLR exe file? In my test I used SMA.dll from PowerShell Core.

I used Windows PowerShell.exe as I knew that had that info populated. I see that SMA.dll from PSCore6 does have that info as does powershell.exe from PSCore6. So dotnet build is adding that, but the executable doesn't have it.

This might be because the executable is an actual ELF binary while the dlls are using the same format as Windows making them portable.

thezim · 2017-10-20T12:33:09Z

This will fix #5034 as well.

iSazonov · 2017-10-20T13:16:00Z

It seems CoreFX use System.Reflection.Metadata to read FileVersionInfo. Perhaps we can use the API to write meta data too.
CoreFX implementation

SteveL-MSFT · 2017-10-21T16:05:15Z

@iSazonov I think we can move to that later particularly if we expose cmdlets for it

iSazonov · 2017-10-21T19:19:57Z

@SteveL-MSFT Do you want to exclude Unix from the PR?

SteveL-MSFT · 2017-10-21T19:59:58Z

@iSazonov using the file command, the executable is a native executable whereas the .dll assemblies are PE32+ format which supports the embedded resources. I don't think we can support this for non-Windows executables.

iSazonov · 2017-10-21T20:50:32Z

@SteveL-MSFT Thanks for clarify. I see Unix haven't a standard for this.

TravisEz13 · 2017-10-23T17:46:40Z

build.psm1

+    ## need RCEdit to modify the binaries embedded resources
+    if (-not (Test-Path "~/.rcedit/rcedit-x64.exe"))
+    {
+        $rceditUrl = "https://github.com/electron/rcedit/releases/download/v1.0.0/rcedit-x64.exe"


Can we install this via chocolatey or nuget? Based on my understanding of our requirements for release builds, this will have to be rewritten sooner rather than later.

And move it to Start-PSBootstrap?

I don't found nuget package.

It's not on chocolatey or nuget currently. I could move the install to start-psbootstrap.

It's under MIT license. Nothing keeps us from packaging it our self... and chocolatey, doesn't even package it, it just encapsulates the installation code.

But this can wait until we have to do it.

iSazonov · 2017-10-26T05:18:45Z

build.psm1

@@ -1442,6 +1442,15 @@ function Start-PSBootstrap {

        # Install Windows dependencies if `-Package` or `-BuildWindowsNative` is specified
        if ($Environment.IsWindows) {
+            ## need RCEdit to modify the binaries embedded resources
+            if (-not (Test-Path "~/.rcedit/rcedit-x64.exe"))


What about Windows 32-bit?

Yeah, will add 32-bit support

Actually, I don't think any change is needed here. I believe we build x86 running as x64, so we can still use the x64 rcedit to modify the x86 binary.

Clear. Thanks.

Closed.

use rcedit to embed icon and version information into pwsh.exe

b3c8300

SteveL-MSFT assigned TravisEz13 Oct 20, 2017

SteveL-MSFT requested a review from TravisEz13 October 20, 2017 03:42

SteveL-MSFT requested review from adityapatwardhan and daxian-dbw as code owners October 20, 2017 03:42

iSazonov reviewed Oct 20, 2017

View reviewed changes

TravisEz13 requested changes Oct 23, 2017

View reviewed changes

address Travis' comments

1a06bb5

TravisEz13 approved these changes Oct 25, 2017

View reviewed changes

iSazonov reviewed Oct 26, 2017

View reviewed changes

TravisEz13 merged commit 4df7036 into PowerShell:master Oct 27, 2017

SteveL-MSFT deleted the rcedit branch November 10, 2017 02:11

thezim mentioned this pull request Sep 2, 2018

Why do we use rcedit? #7688

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use rcedit to embed icon and version information into pwsh.exe #5178

use rcedit to embed icon and version information into pwsh.exe #5178

SteveL-MSFT commented Oct 20, 2017 •

edited

Loading

iSazonov Oct 20, 2017

SteveL-MSFT Oct 20, 2017

SteveL-MSFT Oct 20, 2017

iSazonov Oct 20, 2017

SteveL-MSFT Oct 20, 2017

SteveL-MSFT Oct 20, 2017

SteveL-MSFT Oct 20, 2017

iSazonov Oct 21, 2017 •

edited

Loading

SteveL-MSFT Oct 21, 2017

SteveL-MSFT Oct 21, 2017

thezim commented Oct 20, 2017

iSazonov commented Oct 20, 2017 •

edited

Loading

SteveL-MSFT commented Oct 21, 2017

iSazonov commented Oct 21, 2017

SteveL-MSFT commented Oct 21, 2017

iSazonov commented Oct 21, 2017

TravisEz13 Oct 23, 2017

TravisEz13 Oct 23, 2017

iSazonov Oct 24, 2017

SteveL-MSFT Oct 24, 2017

TravisEz13 Oct 25, 2017

TravisEz13 Oct 25, 2017

iSazonov Oct 26, 2017

SteveL-MSFT Oct 26, 2017

SteveL-MSFT Oct 26, 2017

iSazonov Oct 26, 2017

use rcedit to embed icon and version information into pwsh.exe #5178

use rcedit to embed icon and version information into pwsh.exe #5178

Conversation

SteveL-MSFT commented Oct 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iSazonov Oct 21, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thezim commented Oct 20, 2017

iSazonov commented Oct 20, 2017 • edited Loading

SteveL-MSFT commented Oct 21, 2017

iSazonov commented Oct 21, 2017

SteveL-MSFT commented Oct 21, 2017

iSazonov commented Oct 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SteveL-MSFT commented Oct 20, 2017 •

edited

Loading

iSazonov Oct 21, 2017 •

edited

Loading

iSazonov commented Oct 20, 2017 •

edited

Loading