Improve script `Resolve-Dependency.ps1`

[johlju]

Pull Request

Pull Request (PR) description

Changed

• Pipeline script for resolving dependencies improved.
  • Evaluating PowerShellGet version now supports parameter AllowOldPowerShellGetModule (still not recommended to use this parameter).
  • Now defaults to save the modules PowerShellGet and PackageManagement to the folder output/RequiredModules (same logic as for module PSDepend) to not make permanent changes to the contributors machine. If parameter PSDependTarget is either set to CurrentUser or AllUsers the modules are installed.
• Updated text in the CONTRIBUTING.md to help contributors more easily find a guide where to start.

Fixed

• Pipeline script for resolving dependencies improved.
  • Get-PackageProvider no longer throws an exception when NuGet provider is missing (in Windows PowerShell in a clean Windows install).
  • Install-PackageProvider now defaults to installing in the current user scope to avoid requiring an elevated prompt. This is the only change that is permanent on the contributors machine. It is not possible to avoid this as long at the module PowerShellGet requires the NuGet package provider.
  • Remove duplicate code that set AllowPrerelease when installing package provider.
  • Fixed wrong splatting variable that prevented Install-PackageProvider to run.
  • Removing all existing PowerShellGet and PackageManagement module that is loaded into the session to load the newly saved or installed.
  • Handle parameter AllowOldPowerShellGetModule when loading PowerShellGet module version.
  • Fix message on Write-Progress statement.
  • Small style cleanups.

Task list

• [ ] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
• [x] Added an entry under the Unreleased section of in the CHANGELOG.md as per format.
• [x] Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency).
• [ ] Documentation added/updated in README.md.
• [ ] Comment-based help added/updated.
• [ ] Localization strings added/updated in all localization files as appropriate.
• [ ] Unit tests added/updated. See DSC Community Testing Guidelines.
• [ ] Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
• [x] New/changed code adheres to DSC Community Style Guidelines.

---

This change is 

[johlju]

@gaelcolas There were a lot of issue running the pipeline script in Windows PowerShell on a newly installed Windows 11. This change solves all the issues I found. I will also update the guide at dscommunity.org.

[codecov[bot]]

Codecov Report

Merging #419 (36b3470) into main (91f40fe) will increase coverage by 0%. The diff coverage is 100%.

@@         Coverage Diff         @@
##           main   #419   +/-   ##
===================================
  Coverage    81%    81%           
===================================
  Files        44     44           
  Lines      2317   2319    +2     
===================================
+ Hits       1897   1899    +2     
  Misses      420    420           

Impacted Files	Coverage Δ
Sampler/suffix.ps1	100% <100%> (ø)

[johlju]

Although, there is one issue I cannot solve in Windows PowerShell, I will document it instead.

After PowerShellGet 2.2.5 and new PackageManagement is saved it is not possible to resolve pre-release dependencies other than starting a fresh session. Even after removing the PowerShellGet and PackageMangement module (and I verified none was imported in session) and importing the latest version of both module PowerShellGet still uses the old PackageManagement module. It results in the error
Find-Module : A parameter cannot be found that matches parameter name 'AllowPrereleaseVersions' because PowerShellGet calls Find-Package in the old version. After restarting the session the build script works like it should again. Very annoying. I can't figure out what keeps the old version lingering around when it is not loaded into the session. Only conclusion is that it is an assembly that is loaded that does not get removed (becuase it can't remove assemblies) when removing the module PackageManagement.

This is only an issue for repos that has pre-releases specified in RequiredModules.ps1.

[johlju]

Added PR https://github.com/dsccommunity/dsccommunity.org/pull/209 to change the docs.

[johlju]

Fixed thd comments, ready for review again. 🙂

[johlju]

.... but build is failing, probably due to new ModuleBuilder... 😞

[johlju]

Added a fix for the aliases since the module creates aliases dynamically during import and should not define them in module manifest.

[gaelcolas]

Even after removing the PowerShellGet and PackageMangement module and importing the latest version of both module PowerShellGet still uses the old PackageManagement module.

Yep, just looked at that and I can't find a way either. Wonder if we should make the checks/bootstrap on another runspace so that when we're done we can directly import the correct version. I don't know how practical that would be though.

[johlju]

Maybe it is possible to do this as the first step and do it in a Start-Job so that the install module stuff runs in other session 🤔 I could give it a try. Not sure how runspaces works so will need to investigate. Would be great to find a solution, because its a bit annoying to have that "bug". 🙂

[johlju]

@gaelcolas I started looking at it, but then I saw that the new preview of PowerShellGet v3 remove the dependence on NuGet. So I'm thinking we merge tis as-is, then instead work on implementing support for PSGet v3 preview instead.

[gaelcolas]

Good point. Will also talk to you later about this.