Update `Enable-PSRemoting` so configuration name for Preview releases #7202

SteveL-MSFT · 2018-06-28T18:49:24Z

PR Summary

Intent was to have the version of the PSSessionConfiguration name not include the v for the version string. Also, Preview releases should standardize on PowerShell.6-Preview instead of clobbering PowerShell.6 so that stable and preview can co-exist side-by-side.

Need to verify on Win10 IoT if Install-PowerShellRemoting.ps1 is still needed anymore as it may be possible to run pwsh -c enable-psremoting from within Windows PowerShell Core removing the need for that script which duplicates Enable-PSRemoting capability.

Update: Not able to get current master build working on Win10 IoT, getting Invalid access to memory error. Will have to investigate this separately from this PR and keep Install-PowerShellRemoting.ps1 for now.

Fix #7119

PR Checklist

PaulHigin · 2018-06-28T20:21:13Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

            // TODO: This should be PSVersionInfo.PSVersionName once we get
            // closer to release. Right now it doesn't support alpha versions.
-            return System.String.Concat("PowerShell.", PSVersionInfo.GitCommitId);
+            string version = PSVersionInfo.GitCommitId;


It would be nice if both these code paths included comments with examples demonstrating what is expected. Otherwise it is a bit confusing.

PaulHigin · 2018-06-28T20:23:15Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

            if ($dotPos -ne -1) {{
                $powershellVersionMajor = $powershellVersionMajor.Substring(0, $dotPos)
            }}
+            if ($PSVersionTable.PSVersion.ToString().Contains(""preview""))


I don't see how appending "preview" gets the Issue PowerShell.6.1.0-preview.3 endpoint name. Where does the ending ".3" come from?

I'll add a comment

dantraMSFT · 2018-06-28T20:44:19Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

+            string version = PSVersionInfo.GitCommitId;
+            if (version.StartsWith("v"))
+            {
+                version = version.Substring(1, version.Length - 1);


You can use the simpler String.Substring(int startIndex) overload

dantraMSFT · 2018-06-28T22:02:05Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

+            # but instead creating a PowerShell.6-Preview endpoint
+            if ($PSVersionTable.PSVersion.ToString().Contains(""preview""))
+            {{
+                $powershellVersionMajor += ""-Preview""


Minor note: I'm curious why we don't use the same casing for Preview as we do in the version string? In one case, we have mixed case Preview (PowerShell.6-Preview) while in the other, lower case (PowerShell.6.1.0-preview.715)

semver.org uses lowercase for their examples of alpha and beta releases, but I don't see any language indicating it must be lowercase. We should consider having a capital P in the semver and package name, but that's outside the scope of this PR.

capitals are not allowed in many semver. I've had to add ToLower to many places in the code to ensure we can release without error.

fix JEA tests

iSazonov · 2018-06-29T10:15:37Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

+                shellName += "-Preview";
+            }
+
+            return shellName;


We build GitCommitId in PSVersionInfo - so maybe build the shellName there too? This can simplify the script below too. And tests.

@iSazonov that's a great suggestion. The alternative is that we add the v to install-powershellremoting.ps1 for the version specific endpoint to make it predictable but inconsistent with the generic 6 and 6-preview endpoints. Let's discuss this in the issue.

Adding or removing v to preview isn't problem but breaking change for release. I believe it is better to use the same code for both versions and the same formatting for both endpoint names.

I believe that it is better to fix the preview version - this is acceptable for version update 6.0 -> 6.1.

PaulHigin

LGTM

based on PS-Committee discussion, decision is to remove `v` from GitCommitId

rjmholt

LGTM!

rjmholt · 2018-07-17T00:19:39Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

        internal static string GetWinrmPluginShellName()
        {
            // PowerShell Core uses a versioned directory to hold the plugin
-            // TODO: This should be PSVersionInfo.PSVersionName once we get


Does the removal of this TODO mean we no longer intend for this to happen?

Removal of this comment means that the current design supports semver (pre-release labels)

daxian-dbw

LGTM. Left a non-blocking comment.

daxian-dbw · 2018-07-17T00:24:59Z

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

            }}
+            # If we are running a Preview version, we don't want to clobber the generic PowerShell.6 endpoint
+            # but instead creating a PowerShell.6-Preview endpoint
+            if ($PSVersionTable.PSVersion.ToString().Contains(""preview""))


nit: Maybe checking !string.IsNullOrEmpty($PSVersionTable.PSVersion.PreReleaseLabel) is slightly better.
This is not a blocking comment.

Just realized it's in script, then even simpler: if ($PSVersionTable.PSVersion.PreReleaseLabel)

One concern is that the current proposal for corefx for SemanticVersion type has a different member: https://github.com/dotnet/corefx/issues/13526

Eventually, we'll want to move to the corefx SemanticVersion type. I'll change it now and we'll update the code base later to adopt SemanticVersion.

I'll change it now and we'll update the code base later to adopt SemanticVersion.

That sounds great!

@SteveL-MSFT Maybe open tracking issue for moving to the corefx SemanticVersion type?

address Dongbo's feedback

…#7202) The intent was to have the version of the PSSessionConfiguration name not include the `v` for the version string. Also, Preview releases should standardize on `PowerShell.6-Preview` instead of clobbering `PowerShell.6` so that stable and preview can co-exist side-by-side. Need to verify on Win10 IoT if `Install-PowerShellRemoting.ps1` is still needed anymore as it may be possible to run `pwsh -c enable-psremoting` from within Windows PowerShell Core removing the need for that script which duplicates `Enable-PSRemoting` capability. Update: Not able to get the current master build working on Win10 IoT, getting `Invalid access to memory` error. Will have to investigate this separately from this PR and keep `Install-PowerShellRemoting.ps1` for now. Fix #7119

remove v from version and use 6-Preview if running preview build

9efb1ef

SteveL-MSFT assigned TravisEz13 Jun 28, 2018

SteveL-MSFT requested a review from PaulHigin June 28, 2018 18:49

SteveL-MSFT requested review from dantraMSFT and mirichmo as code owners June 28, 2018 18:49

SteveL-MSFT added the Breaking-Change breaking change that may affect users label Jun 28, 2018

PaulHigin suggested changes Jun 28, 2018

View reviewed changes

Steve Lee (POWERSHELL) added 2 commits June 28, 2018 14:08

fix tests to match code change

7a0aaef

address Paul's feedback

d857b56

dantraMSFT reviewed Jun 28, 2018

View reviewed changes

address Dan's feedback

38e5465

dantraMSFT reviewed Jun 28, 2018

View reviewed changes

dantraMSFT approved these changes Jun 28, 2018

View reviewed changes

SteveL-MSFT force-pushed the enable-psremoting-name branch 3 times, most recently from a69edd0 to e293501 Compare June 29, 2018 03:55

SteveL-MSFT changed the title ~~WIP: Update Enable-PSRemoting so configuration name for Preview releases~~ Update Enable-PSRemoting so configuration name for Preview releases Jun 29, 2018

[feature]

aa6b5ce

fix JEA tests

SteveL-MSFT force-pushed the enable-psremoting-name branch from e293501 to aa6b5ce Compare June 29, 2018 05:30

iSazonov reviewed Jun 29, 2018

View reviewed changes

SteveL-MSFT changed the title ~~Update Enable-PSRemoting so configuration name for Preview releases~~ WIP: Update Enable-PSRemoting so configuration name for Preview releases Jun 29, 2018

PaulHigin approved these changes Jul 2, 2018

View reviewed changes

SteveL-MSFT changed the title ~~WIP: Update Enable-PSRemoting so configuration name for Preview releases~~ Update Enable-PSRemoting so configuration name for Preview releases Jul 16, 2018

SteveL-MSFT requested review from BrucePay and daxian-dbw as code owners July 16, 2018 20:50

SteveL-MSFT force-pushed the enable-psremoting-name branch 3 times, most recently from cdcd180 to dab083b Compare July 16, 2018 22:26

[feature]

36954a5

based on PS-Committee discussion, decision is to remove `v` from GitCommitId

SteveL-MSFT force-pushed the enable-psremoting-name branch from dab083b to 36954a5 Compare July 16, 2018 23:21

rjmholt approved these changes Jul 17, 2018

View reviewed changes

daxian-dbw approved these changes Jul 17, 2018

View reviewed changes

adityapatwardhan approved these changes Jul 17, 2018

View reviewed changes

[feature]

308e51d

address Dongbo's feedback

TravisEz13 merged commit 0a2f9c8 into PowerShell:master Jul 17, 2018

SteveL-MSFT deleted the enable-psremoting-name branch July 17, 2018 15:36

Update Enable-PSRemoting so configuration name for Preview releases #7202

Update Enable-PSRemoting so configuration name for Preview releases #7202

Uh oh!

Conversation

SteveL-MSFT commented Jun 28, 2018 • edited by TravisEz13 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov Jun 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PaulHigin left a comment

Choose a reason for hiding this comment

Uh oh!

rjmholt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT Jul 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Update `Enable-PSRemoting` so configuration name for Preview releases #7202

Update `Enable-PSRemoting` so configuration name for Preview releases #7202

SteveL-MSFT commented Jun 28, 2018 •

edited by TravisEz13

Loading

iSazonov Jun 29, 2018 •

edited

Loading

SteveL-MSFT Jul 17, 2018 •

edited

Loading