Releases: JustinGrote/ModuleFast
v0.5.1
v0.5.0
New Features
✨Allow Source to be specified just by hostname (e.g. pwsh.gallery) (#93) @JustinGrote
✨ ModuleFast will now search directories for manifests if given one via -Path (da8c72d) @JustinGrote
Bug Fixes and Doc Updates
🧹 Suppress ShouldProcess for Approve Action since it is generic (499d3ff) @JustinGrote
🐛 Fix Default Windows Path going null and throwing an error on Linux (fc8d920) @JustinGrote
📄 Fix major typo about requires files (7b578b0) @JustinGrote
Contributors
Assets 6
ModuleFast v0.4.0
What’s Changed
- 🐛 Fix blob storage extra slash (#92) @JustinGrote
- ✨ Use PowerShell internals for default installation location determination (#90) @trackd
- 🐛Find-LocalModule min comparison using wrong logic (#91) @JustinGrote
Contributors
Assets 6
ModuleFast v0.3.0
What’s Changed
✨New Features
Timeout Parameter
Adds a -Timeout parameter to configure when ModuleFast should time out. Defaults to 30 seconds (#87) @JustinGrote
Test Fixes
- ✅ update dependency test name and target version (#83) @ChrisLGardner
Contributors
Assets 6
ModuleFast v0.2.0
✨New Features
Support for PSResourceGet, RequiredModules, and PSDepend manifest files (#60) @JustinGrote
The -Path parameter can now be directed to a manifest .psd1 or .json file of these alternate specification formats and ModuleFast will resolve and install the packages. In PSDepends case, only Module Specifications are handled, other specifications such as Git repos or formats are ignored. The Repository specification is also ignored until multi-repository support lands in ModuleFast.
ModuleFast has some limited autodetection for the format used, but in case it guesses wrong, there is also a new -SpecFileType parameter to explicitly define which format the file is in. Check the debug messages to see which format it detected and why.
-Scope CurrentUser Parameter
-Scope CurrentUser has been added to mimic the Install-Module behavior, and the automatic profile setup is excluded when this parameter is used on Windows. Thanks @trackd!
🐛Bug Fixes
- 🐛 Some classic paths not able to be processed correctly (#72) @JustinGrote
- -PassThru Output is broken (#71) @JustinGrote
- 🐛 Make CurrentUser work properly and ignore profile setup (#65) @trackd
- 🐛 Handle NuGetVersion Edge Case with repeated zeroes (#59) @JustinGrote
Contributors
Assets 6
ModuleFast v0.1.2
What's Changed
The module is now PowerShell 7.2 compatible again
♻️ Replace Clean block for 7.2 Compatibility by @JustinGrote in #56
Contributors
Assets 5
ModuleFast v0.1.0
💥BREAKING CHANGES
PowerShell 7.3+ Required
ModuleFast makes use of the new CLEAN block in PowerShell 7.3 scripts to ensure tasks are cleaned up successfully. This requires 7.3+ (7.4+ recommended) NOTE: This has been reverted in ModuleFast v0.1.2 and PowerShell 7.2 is supported again with this update.
ModuleFast Evaluates all PSModulePath Folders for local installation
ModuleFast previously only evaluated the specified target folder to see if modules were available for installation that satisfied the specifications. ModuleFast now will evaluate all folders in your PSModulePath for installed modules which will speed installation if modules already exist that meet the spec. If this behavior is undesirable, add the -DestinationOnly parameter which will evaluate only the destination for planning purposes.
✨ New Features
Prerelease Support
Video.mp4
ModuleFast now supports installing prerelease modules. You can install prerelease modules in one of three ways:
- Specifying the
-Prereleaseparameter will install the latest available prerelease for all specifications, unless the specification specifically restricts their use (e.g.Package>1.0.0will not install1.0.0-alpha1because it is considered a lower version, butPackage<1.0.0will install the latest1.0.0prerelease but never the released1.0.0version) - You can specify a prerelease version in the version field for specification formats that support it. For instance,
Package=1.0.0-alpha1 - You can request the latest prerelease version for any specification by adding a ! to the beginning or end of the module name. For instance,
Package!,!Package, orPackage!>=2.0.0. This allows you to mix and match pre-release and non-prerelease specifications as needed.
Shorthand String Syntax
Video.mp4
ModuleFast now supports a shorthand string syntax for module specifications. See Get-Help Install-ModuleFast -Full for more information and examples.
SpecFiles
ModuleFast supports the creation of SpecFiles (aka Requires Files) that define a module Installation plan, in various formats (.psd1, .json) See Get-Help Install-ModuleFast -Full for more information and examples.
LockFile Support
Install-ModuleFast now has a -CI parameter that, when installing modules, will also write a lockfile to the particular folder to pin the current versions of modules, so that when Install-ModuleFast -CI is run again, it will install exactly the same versions as what is present in the lockfile. This is useful to commit to a repository to ensure Github Actions or other CI builds always use the same module versions the developer used and avoids breaking changes from later modules being released that meet the specification. Specifying -Update along with -CI will override this behavior and create a new lockfile if newer versions are desired to be committed.
Install-ModuleFast -Plan Parameter
The -Plan parameter will return the modules to be installed given a certain set of specifications. It is the same as -WhatIf but without the additional WhatIf output
"Requires" Processing
ModuleFast now supports a -Path parameter can now read the #Requires line of .ps1 script files or the RequiredModules line of module manifests in order to install the required modules for the script/module.
Interrupted Module Cleanup
ModuleFast will now detect if a module was not fully installed or was otherwise interrupted and clean it up with a warning upon another installation attempt. Note this currently does not apply to module dependencies if the primary module installed successfully but the subsequent dependencies did not.
Incorrect GUID Detection
If a GUID is specified as part of a ModuleFast specification, it will be verified at installation time to match the module. This can help with accidental name collisions across different repositories, but is generally not recommended to use because plan cannot detect it due to the GUID not being present in a standard NuGet v3 metadata location and will warn about it.
Logging and Errors
Verbose and Debug have been organized better to express the "what" and the "how" separately. Terminating Errors have been updated to more clearly indicate the error came from ModuleFast and not another part of the code.
⚰️Deprecations
Get-ModuleFastPlan
Get-ModuleFastPlan will likely not receive any further updates or parameters, it is recommend to use Install-ModuleFast -Plan or Install-ModuleFast -WhatIf for the same result. While typically this would remain a secondary command, the bootstrap nature of Install-ModuleFast makes sense to unify the surface area to a single command to minimize bugs.
⚡Performance Improvements
Request Caching
ModuleFast will now cache requests to the repository registry for subsequent operations to improve performance for the life of the PowerShell session. It does not cache package binaries. It also currently does not detect if the upstream repository has new modules. To detect new modules, either restart your PowerShell session, use the -Update parameter of Install-ModuleFast which will clear the cache as part of its process, or use the Clear-ModuleFastCache command
Dependency Request Deduplication
Multiple Requests for the same origin info are now deduplicated using a reference lookup. This was most apparent when installing the Az module, as many modules depend on Az.Accounts and until the first one fully resolved, all lookups would request Az.Accounts in parallel until the first request had resolved. This has been fixed so after the first Az.Accounts request, all subsequent requests will get a Task that resolves to that initial request rather than initiating a new request.
Local Module Discovery
The local module discovery engine has been optimized to minimize disk access and deduplicate redundant operations.
Cancellation Token Coordination
If a ModuleFast cmdlet is cancelled, it should now appropriately cancel all outstanding HTTP operations.
Page Request Minimization
ModuleFast is now much more intelligent about the pages it requests, reducing load on the origin server and round trip time to evaluate modules. For best performance, request the latest module or specify a specific non-open-ended RequiredVersion or Version range.
📄Documentation Updates
Detailed Help
Detailed help has been added to Install-ModuleFast for all the primary scenarios.
README
The Readme has been updated for additional implementation details and goals roadmap.
Pull Requests
- 💥 Remove ModuleFastPath Parameter by @JustinGrote in #10
- ♻️ Switch to embedded NuGetVersion from custom classes by @JustinGrote in #11
- 🎉 Add Initial Prerelease Support and Enable Prerelease automatically if specified by @JustinGrote in #12
- 🎉 Add per-spec Prerelease support by @JustinGrote in #13
- Fixes and improvements for module installation logic by @JustinGrote in #16
- 🎉 Initial SpecFile Support by @JustinGrote in #17
- Fix alias in Install-ModuleFast by @johlju in #18
- 🎉 Add support for #requires in scripts and modules by @JustinGrote in #24
- 🎉 SpecFile Detection and LockFIles by @JustinGrote in #25
- ♻️ Coordinate Cancellation Tokens by @JustinGrote in #29
- Refactor local module find process by @JustinGrote in #30
- 🎉 Incomplete Module Handling by @JustinGrote in #32
- 🐛 Fix -Update not verifying local module is best. by @JustinGrote in #33
- ✨Add PassThru Implementation and Test by @JustinGrote in #37
- 📄 Add many additional help examples by @JustinGrote in #38
- ⚡Add cache for origin requests by @JustinGrote in #39
- Support Module Manifests with constrained language scope by @JustinGrote in #40
- Fix errors when GUID is not used with MaximumVersion by @JustinGrote in #44
- 🐛 Fix Best Candidate comparison bug by @JustinGrote in #49
New Contributors
Full Changelog: v0.0.1...v0.1.0
Contributors
Assets 5
ModuleFast v0.1.0 RC1
To try this release:
$env:MFRELEASE='v0.1.0-rc1';iwr bit.ly/modulefastmain | iex
Or
Install-PSResource ModuleFast -PreRelease
✨ New Features
Prerelease Support
Video.mp4
ModuleFast now supports installing prerelease modules. You can install prerelease modules in one of three ways:
- Specifying the
-Prereleaseparameter will install the latest available prerelease for all specifications, unless the specification specifically restricts their use (e.g.Package>1.0.0will not install1.0.0-alpha1because it is considered a lower version, butPackage<1.0.0will install the latest1.0.0prerelease but never the released1.0.0version) - You can specify a prerelease version in the version field for specification formats that support it. For instance,
Package=1.0.0-alpha1 - You can request the latest prerelease version for any specification by adding a ! to the beginning or end of the module name. For instance,
Package!,!Package, orPackage!>=2.0.0. This allows you to mix and match pre-release and non-prerelease specifications as needed.
Shorthand String Syntax
Video.mp4
ModuleFast now supports a shorthand string syntax for module specifications. See Get-Help Install-ModuleFast -Full for more information and examples.
SpecFiles
ModuleFast supports the creation of SpecFiles (aka Requires Files) that define a module Installation plan, in various formats (.psd1, .json) See Get-Help Install-ModuleFast -Full for more information and examples.
LockFile Support
Install-ModuleFast now has a -CI parameter that, when installing modules, will also write a lockfile to the particular folder to pin the current versions of modules, so that when Install-ModuleFast -CI is run again, it will install exactly the same versions as what is present in the lockfile. This is useful to commit to a repository to ensure Github Actions or other CI builds always use the same module versions the developer used and avoids breaking changes from later modules being released that meet the specification. Specifying -Update along with -CI will override this behavior and create a new lockfile if newer versions are desired to be committed.
Install-ModuleFast -Plan Parameter
The -Plan parameter will return the modules to be installed given a certain set of specifications. It is the same as -WhatIf but without the additional WhatIf output
"Requires" Processing
ModuleFast now supports a -Path parameter can now read the #Requires line of .ps1 script files or the RequiredModules line of module manifests in order to install the required modules for the script/module.
Interrupted Module Cleanup
ModuleFast will now detect if a module was not fully installed or was otherwise interrupted and clean it up with a warning upon another installation attempt. Note this currently does not apply to module dependencies if the primary module installed successfully but the subsequent dependencies did not.
Incorrect GUID Detection
If a GUID is specified as part of a ModuleFast specification, it will be verified at installation time to match the module. This can help with accidental name collisions across different repositories, but is generally not recommended to use because plan cannot detect it due to the GUID not being present in a standard NuGet v3 metadata location and will warn about it.
Logging and Errors
Verbose and Debug have been organized better to express the "what" and the "how" separately. Terminating Errors have been updated to more clearly indicate the error came from ModuleFast and not another part of the code.
⚰️Deprecations
Get-ModuleFastPlan
Get-ModuleFastPlan will likely not receive any further updates or parameters, it is recommend to use Install-ModuleFast -Plan or Install-ModuleFast -WhatIf for the same result. While typically this would remain a secondary command, the bootstrap nature of Install-ModuleFast makes sense to unify the surface area to a single command to minimize bugs.
⚡Performance Improvements
Request Caching
ModuleFast will now cache requests to the repository registry for subsequent operations to improve performance for the life of the PowerShell session. It does not cache package binaries. It also currently does not detect if the upstream repository has new modules. To detect new modules, either restart your PowerShell session or use the Clear-ModuleFastCache command
Dependency Request Deduplication
Multiple Requests for the same origin info are now deduplicated using a reference lookup. This was most apparent when installing the Az module, as many modules depend on Az.Accounts and until the first one fully resolved, all lookups would request Az.Accounts in parallel until the first request had resolved. This has been fixed so after the first Az.Accounts request, all subsequent requests will get a Task that resolves to that initial request rather than initiating a new request.
Local Module Discovery
The local module discovery engine has been optimized to minimize disk access and deduplicate redundant operations.
Cancellation Token Coordination
If a ModuleFast cmdlet is cancelled, it should now appropriately cancel all outstanding HTTP operations.
Page Request Minimization
ModuleFast is now much more intelligent about the pages it requests, reducing load on the origin server and round trip time to evaluate modules. For best performance, request the latest module or specify a specific non-open-ended RequiredVersion or Version range.
📄Documentation Updates
Detailed Help
Detailed help has been added to Install-ModuleFast for all the primary scenarios.
README
The Readme has been updated for additional implementation details and goals roadmap.
🌿Pull Requests
- 💥 Remove ModuleFastPath Parameter by @JustinGrote in #10
- ♻️ Switch to embedded NuGetVersion from custom classes by @JustinGrote in #11
- 🎉 Add Initial Prerelease Support and Enable Prerelease automatically if specified by @JustinGrote in #12
- 🎉 Add per-spec Prerelease support by @JustinGrote in #13
- Fixes and improvements for module installation logic by @JustinGrote in #16
- 🎉 Initial SpecFile Support by @JustinGrote in #17
- Fix alias in Install-ModuleFast by @johlju in #18
- 🎉 Add support for #requires in scripts and modules by @JustinGrote in #24
- 🎉 SpecFile Detection and LockFIles by @JustinGrote in #25
- ♻️ Coordinate Cancellation Tokens by @JustinGrote in #29
- Refactor local module find process by @JustinGrote in #30
- 🎉 Incomplete Module Handling by @JustinGrote in #32
- 🐛 Fix -Update not verifying local module is best. by @JustinGrote in #33
- ✨Add PassThru Implementation and Test by @JustinGrote in #37
- 📄 Add many additional help examples by @JustinGrote in #38
- ⚡Add cache for origin requests by @JustinGrote in #39
- Support Module Manifests with constrained language scope by @JustinGrote in #40
New Contributors
Full Changelog: v0.0.1...v0.1.0
Contributors
Assets 4
BootstrapTest
This is a test release to try out bootstrapping a signed release