Public/Uninstall-AtwsOldModuleVersion.ps1
|
#Requires -Version 4.0 <# .COPYRIGHT Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function Uninstall-AtwsOldModuleVersion { <# .SYNOPSIS This function uninstalls old module versions. .DESCRIPTION When you update modules from Powershell Gallery with built-in functions any new module versions are installed alongside existing versions. Sometimes this may cause problems, including wasting disk space. This function gets a list of all installed versions of a module and uninstalls every version but the last. .INPUTS Nothing, only a parameter. .OUTPUTS Nothing, it only deletes. .EXAMPLE Uninstall-AtwsOldModuleVersion Uninstalls all but the last version of this module. .EXAMPLE Uninstall-AtwsOldModuleVersion -ModuleName ModuleName Uninstalls all but the last version of any module named ModuleName. .NOTES NAME: Uninstall-AtwsOldModuleVersion #> [CmdLetBinding( SupportsShouldProcess = $true, ConfirmImpact = 'Medium' )] Param( # The name of the module where all versions but the last should be uninstalled. [Alias('Name')] [string] $ModuleName = $MyInvocation.MyCommand.ModuleName ) begin { # Enable modern -Debug behavior if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) $Latest = Get-InstalledModule -Name $ModuleName $AllVersions = Get-InstalledModule -Name $ModuleName -AllVersions $cacheRoot = Split-Path -Parent $Script:Atws.DynamicCache } process { # If there is only a single module version installed, do nothing if ($AllVersions.count -gt 1) { # Prepare for removal, use confirmimpact to verify potentially destructive action $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: Uninstalling {1} old versions of module {2}' -F $caption, $AllVersions.count, $ModuleName $verboseWarning = '{0}: About to uninstall {1} old versions of module {2}. Do you want to continue?' -F $caption, $AllVersions.count, $ModuleName if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { $Activity = 'Uninstalling {0} old versions of module {1}' -F $AllVersions.count, $ModuleName foreach ($Version in $AllVersions) { # Progress bar $Index = $AllVersions.IndexOf($Version) + 1 $PercentComplete = $Index / $AllVersions.Count * 100 $Status = 'Module {0}/{1} ({2:n0}%)' -F $Index, $AllVersions.Count, $PercentComplete $CurrentOperation = "Uninstalling version {0}" -F $Version.version Write-AtwsProgress -Activity $Activity -Status $Status -PercentComplete $PercentComplete -CurrentOperation $CurrentOperation if ($Version.version -ne $latest.version) { Write-Verbose "Uninstalling $($sm.name) - $($sm.version) [latest is $($latest.version)]" $Version | Uninstall-Module -Force # A bit of customization to our own module if ($ModuleName -eq $MyInvocation.MyCommand.ModuleName) { $cacheDir = Join-Path $cacheRoot $Version.version if (Test-Path $cacheDir -and $ModuleName -eq 'Autotask') { # Delete associated cache directory. Could be one in use if the module is beta, # but then the next module load will recreate it Remove-Item -Recurse -Force $cacheDir } } } } } } if ($CurrentOperation) { Write-AtwsProgress -Activity $Activity -Status $Status -PercentComplete $PercentComplete -CurrentOperation $CurrentOperation -Completed } } end { Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) } } |