Signalling deprecation: Shoulder Taps

Windos · Sep 16, 2020 · 6587f03 · 6587f03
1 parent 613c864
commit 6587f03
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 3 deletions.
diff --git a/BurntToast/BurntToast.psd1 b/BurntToast/BurntToast.psd1
@@ -1,6 +1,6 @@
 @{
     RootModule        = 'BurntToast.psm1'
-    ModuleVersion     = '0.8.0'
+    ModuleVersion     = '0.8.1'
     # Can only use CompatiblePSEditions if PowerShellVersion is set to 5.1, not sure about limiting this to that version yet.
     # CompatiblePSEditions = @('Desktop')
     GUID              = '751a2aeb-a68f-422e-a2ea-376bdd81612a'
@@ -40,8 +40,12 @@
             Tags         = @('Notifications', 'Utilities', 'Windows10', 'Toast')
             LicenseUri   = 'https://github.com/Windos/BurntToast/blob/main/LICENSE'
             ProjectUri   = 'https://github.com/Windos/BurntToast'
-            IconUri      = 'https://raw.githubusercontent.com/Windos/BurntToast/main/Media/BurntToast-Logo.png'
-            ReleaseNotes = '# 0.8.0
+            IconUri      = 'https://raw.githubusercontent.com/Windos/BurntToast/master/Media/BurntToast-Logo.png'
+            ReleaseNotes = '# 0.8.1
+
+* Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0
+
+# 0.8.0
 
 * Fix: Images from UNC path failing (#111)
 * Add: Ability to force a refresh of cached images via IgnoreCache switch on New-BTImage

diff --git a/BurntToast/Public/New-BTShoulderTapBinding.ps1 b/BurntToast/Public/New-BTShoulderTapBinding.ps1
@@ -20,6 +20,7 @@
         https://github.com/Windos/BurntToast/blob/main/Help/New-BTShoulderTapBinding.md
     #>
 
+    [Obsolete('This cmdlet is being deprecated, it will be removed in v0.9.0')]
     [OutputType([Microsoft.Toolkit.Uwp.Notifications.ToastBindingShoulderTap])]
     param (
         # The image displayed in the Shoulder Tap notification, this object is created using the New-BTShoulderTapImage function.

diff --git a/BurntToast/Public/New-BTShoulderTapImage.ps1 b/BurntToast/Public/New-BTShoulderTapImage.ps1
@@ -23,6 +23,7 @@
         https://github.com/Windos/BurntToast/blob/main/Help/New-BTShoulderTapImage.md
     #>
 
+    [Obsolete('This cmdlet is being deprecated, it will be removed in v0.9.0')]
     [CmdletBinding(DefaultParameterSetName = 'Image')]
     [OutputType([Microsoft.Toolkit.Uwp.Notifications.ToastShoulderTapImage])]
 

diff --git a/BurntToast/Public/New-BTShoulderTapPeople.ps1 b/BurntToast/Public/New-BTShoulderTapPeople.ps1
@@ -21,6 +21,7 @@
         https://github.com/Windos/BurntToast/blob/main/Help/New-BTShoulderTapPeople.md
     #>
 
+    [Obsolete('This cmdlet is being deprecated, it will be removed in v0.9.0')]
     [CmdletBinding(DefaultParameterSetName = 'Email')]
     [OutputType([Microsoft.Toolkit.Uwp.Notifications.ToastPeople])]
 

diff --git a/BurntToast/Public/New-BurntToastShoulderTap.ps1 b/BurntToast/Public/New-BurntToastShoulderTap.ps1
@@ -37,6 +37,7 @@
         https://github.com/Windos/BurntToast/blob/main/Help/New-BurntToastShoulderTap.md
     #>
 
+    [Obsolete('This cmdlet is being deprecated, it will be removed in v0.9.0')]
     [alias('ShoulderTap')]
     [CmdletBinding(SupportsShouldProcess   = $true)]
     param (

diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,9 @@
 # Full Change Log
 
+- [v0.8.1](https://github.com/Windos/BurntToast/releases/download/v0.8.1/BurntToast.zip)
+
+  - Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0
+
 - [v0.8.0](https://github.com/Windos/BurntToast/releases/download/v0.8.0/BurntToast.zip)
 
   - Fix: Images from UNC path failing ([#111](https://github.com/Windos/BurntToast/issues/111))

diff --git a/README.md b/README.md
@@ -62,6 +62,10 @@ if you using Powershell 6 or later, extract into `$env:userprofile\Documents\Pow
 
 - [Bleeding Edge](https://github.com/Windos/BurntToast/archive/v0.8.1.zip) (Development/Raw Repo)
 
+- [v0.8.1](https://github.com/Windos/BurntToast/releases/download/v0.8.1/BurntToast.zip)
+
+  - Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0
+
 - [v0.8.0](https://github.com/Windos/BurntToast/releases/download/v0.8.0/BurntToast.zip)
 
   - Fix: Images from UNC path failing ([#111](https://github.com/Windos/BurntToast/issues/111))