Merge branch 'development'

shaneis · May 15, 2019 · 1f17695 · 1f17695
2 parents 59f2f41 + 3029274
commit 1f17695
Show file tree

Hide file tree

Showing 2 changed files with 91 additions and 0 deletions.
diff --git a/allcommands.ps1 b/allcommands.ps1
@@ -51603,6 +51603,66 @@ OPTION (RECOMPILE);"
         }
     }
 }
+function Get-DbatoolsChangeLog {
+    <#
+    .SYNOPSIS
+        Opens the link to our online change log
+
+    .DESCRIPTION
+        Opens the link to our online change log. To see the local changelog instead, use the Local parameter.
+
+    .PARAMETER Local
+        Return the local change log to the console
+
+    .PARAMETER EnableException
+        By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
+        This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
+        Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
+
+    .NOTES
+        Tags: changelog
+        Author: Chrissy LeMaire (@cl), netnerds.net
+
+        Website: https://dbatools.io
+        Copyright: (c) 2018 by dbatools, licensed under MIT
+        License: MIT https://opensource.org/licenses/MIT
+
+    .LINK
+        https://dbatools.io/Get-DbatoolsChangeLog
+
+    .EXAMPLE
+        Get-DbatoolsChangeLog
+
+        Opens a browser to our online changelog
+
+    .EXAMPLE
+        Get-DbatoolsChangeLog -Local
+
+        Returns the content from changelog.md
+#>
+    [CmdletBinding()]
+    param (
+        [switch]$Local,
+        [switch]$EnableException
+    )
+
+    try {
+        if (-not $Local) {
+            Start-Process "https://github.com/sqlcollaborative/dbatools/blob/development/changelog.md"
+        } else {
+            $releasenotes = Get-Content $script:PSModuleRoot\changelog.md -Raw
+
+            if ($Local) {
+                ($releasenotes -Split "##Local")[0]
+            } else {
+                $releasenotes
+            }
+        }
+    } catch {
+        Stop-Function -Message "Failure" -ErrorRecord $_
+        return
+    }
+}
 function Get-DbatoolsLog {
     <#
     .SYNOPSIS

diff --git a/bin/dbatools-index.json b/bin/dbatools-index.json
@@ -19682,6 +19682,37 @@
                    ],
         "Syntax":  "Get-DbaTempdbUsage [-SqlInstance] \u003cDbaInstanceParameter[]\u003e [[-SqlCredential] \u003cPSCredential\u003e] [-EnableException] [\u003cCommonParameters\u003e]"
     },
+    {
+        "Name":  "Get-DbatoolsChangeLog",
+        "Description":  "Opens the link to our online change log. To see the local changelog instead, use the Local parameter.",
+        "Tags":  "changelog",
+        "Synopsis":  "Opens the link to our online change log",
+        "Alias":  "",
+        "Author":  "Chrissy LeMaire (@cl), netnerds.net",
+        "CommandName":  "Get-DbatoolsChangeLog",
+        "Availability":  "Windows, Linux, macOS",
+        "Links":  "https://dbatools.io/Get-DbatoolsChangeLog",
+        "Examples":  "-------------------------- EXAMPLE 1 --------------------------\nPS C:\\\u003eGet-DbatoolsChangeLog\nOpens a browser to our online changelog\n-------------------------- EXAMPLE 2 --------------------------\nPS C:\\\u003eGet-DbatoolsChangeLog -Local\nReturns the content from changelog.md",
+        "Params":  [
+                       [
+                           "Local",
+                           "Return the local change log to the console",
+                           "",
+                           false,
+                           "false",
+                           "False"
+                       ],
+                       [
+                           "EnableException",
+                           "By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.\r\nThis avoids overwhelming you with \"sea of red\" exceptions, but is inconvenient because it basically disables advanced scripting.\r\nUsing this switch turns this \"nice by default\" feature off and enables you to catch exceptions with your own try/catch.",
+                           "",
+                           false,
+                           "false",
+                           "False"
+                       ]
+                   ],
+        "Syntax":  "Get-DbatoolsChangeLog [-Local] [-EnableException] [\u003cCommonParameters\u003e]"
+    },
     {
         "Name":  "Get-DbatoolsConfig",
         "Description":  "Retrieves configuration elements by name.\nCan be used to search the existing configuration list.",