Merge pull request #115 from Windos/v0.8.1

v0.8.1
Windos · Sep 17, 2020 · b03dd65 · b03dd65
2 parents 613c864 + ab02545
commit b03dd65
Show file tree

Hide file tree

Showing 10 changed files with 39 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'
@@ -41,7 +41,13 @@
             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
+            ReleaseNotes = '# 0.8.1
+
+* Fix: Toast alias removed in 0.8.0 has been restored
+* Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0
+* Deprecation: Signalling removal of Path parameter from New-BTAudio in future version, v0.9.0. https://github.com/MicrosoftDocs/windows-uwp/issues/1593
+
+# 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-BTAudio.ps1 b/BurntToast/Public/New-BTAudio.ps1
@@ -82,6 +82,7 @@
         [Parameter(Mandatory,
                    ParameterSetName = 'CustomSound')]
         [ValidateScript({Test-BTAudioPath $_})]
+        [Obsolete('Unfortunately, custom sounds no longer work and this parameter will be removed in v0.9.0. See: https://github.com/MicrosoftDocs/windows-uwp/issues/1593')]
         [string] $Path,
 
         # Specifies that the slected sound should play multiple times if its duration is shorter than that of the toast it accompanies.

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-BurntToastNotification.ps1 b/BurntToast/Public/New-BurntToastNotification.ps1
@@ -67,6 +67,7 @@
         https://github.com/Windos/BurntToast/blob/main/Help/New-BurntToastNotification.md
     #>
 
+    [Alias('Toast')]
     [CmdletBinding(DefaultParameterSetName = 'Sound',
                    SupportsShouldProcess   = $true)]
     param (

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

diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,15 @@
 # Full Change Log
 
+- [v0.8.1](https://github.com/Windos/BurntToast/releases/download/v0.8.1/BurntToast.zip)
+
+  - Fix: Toast alias removed in 0.8.0 has been restored
+
+  - Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0
+
+  - Deprecation: Signalling removal of Path parameter from New-BTAudio in future version, v0.9.0.
+
+    - https://github.com/MicrosoftDocs/windows-uwp/issues/1593
+
 - [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,16 @@ 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)
+
+  - Fix: Toast alias removed in 0.8.0 has been restored
+
+  - Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0
+
+  - Deprecation: Signalling removal of Path parameter from New-BTAudio in future version, v0.9.0.
+
+    - https://github.com/MicrosoftDocs/windows-uwp/issues/1593
+
 - [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/Tests/BurntToast.Tests.ps1 b/Tests/BurntToast.Tests.ps1
@@ -653,6 +653,10 @@ Describe 'New-BTContent' {
 Describe 'New-BurntToastNotification' {
     $ImagePath = Resolve-Path -Path $PSScriptRoot\..\BurntToast\Images\BurntToast.png
 
+    Context 'has registered alias' {
+        $Aliases = Get-Alias -Name 'Toast' -ErrorAction SilentlyContinue
+        $Aliases.Count | Should -BeGreaterThan 0
+    }
     Context 'running without arguments (default toast)' {
         Start-Transcript tmp.log
         try {