(chocolatey#3520) Deprecate Install-ChocolateyPinnedTaskBarItem

Deprecate the Install-ChocolateyPinnedTaskBarItem command to prepare for it to be removed in v3.
corbob · Sep 26, 2024 · 0d4a172 · 0d4a172
1 parent dd1de8f
commit 0d4a172
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPinnedTaskBarItem.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPinnedTaskBarItem.ps1
@@ -21,7 +21,7 @@ Creates an item in the task bar linking to the provided path.
 
 .NOTES
 Does not work with SYSTEM, but does not error. It warns with the error
-message.
+message. This command is deprecated and will be removed in version 3.0.0.
 
 .INPUTS
 None
@@ -53,6 +53,7 @@ Install-ChocolateyExplorerMenuItem
     )
 
     Write-FunctionCallLogMessage -Invocation $MyInvocation -Parameters $PSBoundParameters
+    Write-Warning "Install-ChocolateyPinnedTaskBarItem has been deprecated in v2.4.0 and will be removed in v3.0.0."
 
     try {
         if (Test-Path($targetFilePath)) {