PowerShell / PowerShell/PowerShellEditorServices

Add extra installation instructions about administrator privileges and PSCore6 modules

Open
#631 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Documentation Issue-Enhancement
Dominant language
C#
Stars
767
Forks
266
Avg merge
3d 16h
Merged PRs (30d)
1

Description

I was trying to build PowerShellEditorServices on my machine with the following $PSVersionTable:

Name                           Value
----                           -----
PSVersion                      6.0.1
PSEdition                      Core
GitCommitId                    v6.0.1-235-g3f7494e5435bd776ad04ef426c00874410924486
OS                             Microsoft Windows 10.0.16299
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0
Install-Module not found

Due to self-hosting on PSCore6, there was no Install-Module cmdlet. It might be worth having a note somewhere (possibly here or in the PowerShell README?) to make sure people use Start-PSBuild -PSModuleRestore when building PSCore6 and get the PowerShellGet module.

Invoke-Build: IsBypassed not supported error

Then at the step where Invoke-Build is used, I got the following error:

PS> Invoke-Build Build
Build Build C:\Users\roholt\Documents\PowerShellEditorServices\PowerShellEditorServices.build.ps1
Task /Build/SetupDotNet

### Installing .NET CLI 2.0.0...

C:
dotnet-install: Downloading link: https://dotnetcli.azureedge.net/dotnet/Sdk/2.0.0/dotnet-sdk-2.0.0-win-x64.zip
dotnet-install: Cannot download: https://dotnetcli.azureedge.net/dotnet/Sdk/2.0.0/dotnet-sdk-2.0.0-win-x64.zip
dotnet-install: Downloading legacy link: https://dotnetcli.azureedge.net/dotnet/Sdk/2.0.0/dotnet-dev-win-x64.2.0.0.zip
ERROR: Exception calling "IsBypassed" with "1" argument(s): "Operation is not supported on this platform."
At C:\Users\roholt\AppData\Local\Temp\dotnet-install.ps1:175 char:20
+ ...          if($DefaultProxy -and (-not $DefaultProxy.IsBypassed($Uri))) ...
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
At C:\Users\roholt\Documents\PowerShellEditorServices\PowerShellEditorServices.build.ps1:21 char:1
+ task SetupDotNet -Before Clean, Build, TestHost, TestServer, TestProt ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
At C:\Users\roholt\Documents\PowerShellEditorServices\PowerShellEditorServices.build.ps1:129 char:1
+ task Build {
+ ~~~~~~~~~~~~
Build FAILED. 2 tasks, 1 errors, 0 warnings 00:00:04.8974401
Exception calling "IsBypassed" with "1" argument(s): "Operation is not supported on this platform."
At C:\Users\roholt\AppData\Local\Temp\dotnet-install.ps1:175 char:20
+ ...          if($DefaultProxy -and (-not $DefaultProxy.IsBypassed($Uri))) ...
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : NotSpecified: (:) [], ParentContainsErrorRecordException
+ FullyQualifiedErrorId : PlatformNotSupportedException

I needed some trial and error to work out that I just needed to be running an administrator session. For the sake of completeness, there is a fixed dotnet-cli issue that looks like this, but we only need administrator privileges here.

PowerShell snippets in README

Also, the PowerShell snippets in the instructions are inconsistent about giving a prompt and we should make them agree. Not including a prompt makes copy-pasting easier, but including a prompt gives more information on where the user should be executing commands. The ideal is including the prompt and having it unselectable -- GitHub does this in their SSH key pages using ::before in CSS, but that can only be set once. It may not be possible in GitHub Markdown, but I've put an attempt below that doesn't work in preview, but may be a start.

 PS C:\path\to\dir> Invoke-Command "do something"

Filing this as an issue chiefly to document it for anyone else who encounters problems but also for discussion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the installation instructions and README sections covering Start-PSBuild, PowerShell snippets, and Invoke-Build. Document the need for an administrator session and the PSCore6 module-restore step, then make the command examples consistent; done means the reported setup issues and prompt-format confusion are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.