After manually updating modules several times, and always forgetting one or more, I decided it was time to automate updating PowerShell modules.
This script:
- Checks for newer versions of installed PowerShell modules and updates those modules
- Optionally processes preview versions of installed PowerShell modules as well
- Optionally runs in 'Reporting Only' mode
The name I chose for this script is an ode to the Evergreen module (https://github.com/aaronparker/Evergreen) by Aaron Parker (@stealthpuppy).
Quick start:
- Download the script to a location of your chosing (for example: C:\Scripts\EvergreenModules)
- Run or schedule the script
You can also install the script from the PowerShell Gallery (EvergreenModules):
Install-Script -Name EvergreenModulesI have scheduled the script to run daily:
EvergreenModules.ps1 -IncludePreviewThe above execution will keep all installed PowerShell modules up to date, including preview versions.
A sample .xml file that you can import in Task Scheduler is provided with this script.
This script processes all the installed PowerShell modules by default. You can scope this using the Include and Exclude parameters to your liking.
SYNTAX
EvergreenModules.ps1 [[-Include] <String[]>] [[-Exclude] <String[]>] [[-IncludePreview]] [[-KeepVersions]] [[-ReportOnly]] [<CommonParameters>]
DESCRIPTION
Script to automatically update your installed PowerShell modules.
Optionally keep old versions or process Preview versions.
PARAMETERS
-Include <String[]>
Optionally scopes the update process to one or more module names.
If more than one module name need to be included, pass in an array of strings.
Supports '*' wildcard.
Required? false
Position? 1
Default value @()
Accept pipeline input? false
Accept wildcard characters? false
-Exclude <String[]>
Optionally provide one or more module names to exclude from the update process.
If more than one module name need to be excluded, pass in an array of strings.
Supports '*' wildcard.
Required? false
Position? 2
Default value @()
Accept pipeline input? false
Accept wildcard characters? false
-IncludePreview [<SwitchParameter>]
Preview versions for modules are not processed by default.
Use this switch parameter to include preview versions in the update process.
This checks for modules that have '-preview' in their Version attributes.
Required? false
Position? 3
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-KeepVersions [<SwitchParameter>]
If used this switch ensures the script will not uninstall older versions if a new version is found and
installed.
Required? false
Position? 4
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ReportOnly [<SwitchParameter>]
If used this switch ensures no modules are updated but available updates are reported.
Required? false
Position? 5
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS C:\>.\EvergreenModules.ps1
Updates all installed PowerShell modules (excluding those that have '-preview' in their Version attribute).
-------------------------- EXAMPLE 2 --------------------------
PS C:\>.\EvergreenModules.ps1 -IncludePreview
Updates all installed PowerShell modules, including those that have '-preview' in their Version attribute.
-------------------------- EXAMPLE 3 --------------------------
PS C:\>.\EvergreenModules.ps1 -ReportOnly
Reports all available updates for all installed PowerShell modules, excluding modules that have '-preview' in
their Version attribute.
-------------------------- EXAMPLE 4 --------------------------
PS C:\>.\EvergreenModules.ps1 -Include @('Az', 'Microsoft*') -Exclude 'Microsoft.Graph.Intune'
Only updates the 'Az' module and modules starting with 'Microsoft', except the module 'Microsoft.Graph.Intune'
If you're getting this error, it's probably because of a known bug when using Known Folder Move with OneDrive (for Business) and thus moving your Documents folder to OneDrive, including the default location for Windows PowerShell modules in the CurrentUser scope. The error is thrown by PowerShellGet, an essential part of PowerShell module management.
More info on this bug here.
Workaround:
- Uninstall any modules is the CurrentUser scope
- Re-install the uninstalled modules in the AllUsers scope
A possible workaround could be (Google-fu, not tested):
- Uninstall any modules in the CurrentUser scope
- Create a folder for CurrentUser scope modules outside of your OneDrive folder structure
- In the 'PSModulePath' environment variable change
C:\Users\<username>\OneDrive - <tenant name>\Documents\WindowsPowerShell\Modules;to the folder you created - Re-install the uninstalled modules in the CurrentUser scope Note that this also changes the default location for your PowerShell profile.
Another possible workaround is offered in another logged issue for the preview release of PowerShellGet (mentioned here):
- Uninstall all versions of PowerShellGet
- Install version 2.2.4.1 of PowerShellGet
- When you run this script use
-Exclude 'PowerShellGet'to prevent automatically upgrading to the newer, bugged, versions